Microsoft.NetApp (preview:2025-09-01)

2025/12/02 • 11 updated methods

ActiveDirectoryConfigs_Update (updated)
Description :  Patch the specified active directory configuration
Reference :  Link ¶

⚶ Changes

{
  "#id": "ActiveDirectoryConfigs_Update",
  "$responses": {
    "202": [
      {
        "@added_a1409241bcc143b399be9df91e1374fc": {
          "#name": "azure-asyncoperation",
          "Description": "A link to the status monitor",
          "Type": "string"
        }
      }
    ]
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/activeDirectoryConfigs/{activeDirectoryConfigName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
activeDirectoryConfigName:
{
Description: The name of the ActiveDirectoryConfig ,
Required: True ,
}
string ,
body:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity assigned to this resource. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The identities assigned to this resource by the user. ,
Required: False ,
}
object ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
userName:
{
Description: A domain user account with permission to create machine accounts ,
Required: False ,
}
string ,
dns:
{
Description: An array of DNS server IP addresses(IPv4 only) for the Active Directory ,
Required: False ,
}
[
string ,
]
,
smbServerName:
{
Description: NetBIOS name of the SMB server. This name will be registered as a computer account in the AD and used to mount volumes ,
Required: False ,
}
string ,
organizationalUnit:
{
Description: The Organizational Unit (OU) within the Windows Active Directory ,
Required: False ,
}
string ,
site:
{
Description: The Active Directory site the service will limit Domain Controller discovery to ,
Required: False ,
}
string ,
backupOperators:
{
Description: Users to be added to the Built-in Backup Operator active directory group. A list of unique usernames without domain specifier ,
Required: False ,
}
[
string ,
]
,
administrators:
{
Description: Users to be added to the Built-in Administrators active directory group. A list of unique usernames without domain specifier ,
Required: False ,
}
[
string ,
]
,
securityOperators:
{
Description: Domain Users in the Active directory to be given SecurityPrivilege privilege (Needed for SMB Continuously available shares for SQL). A list of unique usernames without domain specifier ,
Required: False ,
}
[
string ,
]
,
domain:
{
Description: Name of the Active Directory domain ,
Required: False ,
}
string ,
secretPassword:
{
Description: Access password from Azure KeyVault Secrets to connect Active Directory ,
Required: False ,
}
{
keyVaultProperties:
{
Description: Properties provided by KeyVault. ,
Required: False ,
}
{
keyVaultUri:
{
Description: The Uri of KeyVault. ,
Format: uri ,
Required: False ,
}
string ,
secretName:
{
Description: The name of KeyVault password secret. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: Identity used to authenticate to KeyVault. Applicable if keySource is 'Microsoft.KeyVault'. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID (object ID) of the identity used to authenticate with key vault. Read-only. ,
Required: False ,
}
string ,
userAssignedIdentity:
{
Description: The Azure resource identifier of the user assigned identity used to authenticate with key vault. Applicable if identity.type has 'UserAssigned'. It should match key of identity.userAssignedIdentities. ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
userName:
{
Description: A domain user account with permission to create machine accounts ,
Required: False ,
}
string ,
dns:
{
Description: An array of DNS server IP addresses(IPv4 only) for the Active Directory ,
Required: False ,
}
[
string ,
]
,
smbServerName:
{
Description: NetBIOS name of the SMB server. This name will be registered as a computer account in the AD and used to mount volumes ,
Required: False ,
}
string ,
organizationalUnit:
{
Description: The Organizational Unit (OU) within the Windows Active Directory ,
Required: False ,
}
string ,
site:
{
Description: The Active Directory site the service will limit Domain Controller discovery to ,
Required: False ,
}
string ,
backupOperators:
{
Description: Users to be added to the Built-in Backup Operator active directory group. A list of unique usernames without domain specifier ,
Required: False ,
}
[
string ,
]
,
administrators:
{
Description: Users to be added to the Built-in Administrators active directory group. A list of unique usernames without domain specifier ,
Required: False ,
}
[
string ,
]
,
securityOperators:
{
Description: Domain Users in the Active directory to be given SecurityPrivilege privilege (Needed for SMB Continuously available shares for SQL). A list of unique usernames without domain specifier ,
Required: False ,
}
[
string ,
]
,
activeDirectoryStatus:
{
Description: Status of the Active Directory ,
Enum:
{
Created: Active Directory created but not in use ,
InUse: Active Directory in use by SMB Volume ,
Deleted: Active Directory Deleted ,
Error: Error with the Active Directory ,
Updating: Active Directory Updating ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Azure lifecycle management. ,
Enum:
{
Accepted: Resource has been Accepted ,
Creating: Resource is being Created ,
Patching: Resource is being Patched ,
Updating: Resource is updating ,
Deleting: Resource is being Deleted ,
Moving: Resource is being Moved ,
Failed: Resource has Failed ,
Succeeded: Resource has Succeeded ,
}
,
Required: False ,
}
enum ,
domain:
{
Description: Name of the Active Directory domain ,
Required: True ,
}
string ,
secretPassword:
{
Description: Access password from Azure KeyVault Secrets to connect Active Directory ,
Required: True ,
}
{
keyVaultProperties:
{
Description: Properties provided by KeyVault. ,
Required: False ,
}
{
keyVaultUri:
{
Description: The Uri of KeyVault. ,
Format: uri ,
Required: True ,
}
string ,
secretName:
{
Description: The name of KeyVault password secret. ,
Required: True ,
}
string ,
}
,
identity:
{
Description: Identity used to authenticate to KeyVault. Applicable if keySource is 'Microsoft.KeyVault'. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID (object ID) of the identity used to authenticate with key vault. Read-only. ,
Required: False ,
}
string ,
userAssignedIdentity:
{
Description: The Azure resource identifier of the user assigned identity used to authenticate with key vault. Applicable if identity.type has 'UserAssigned'. It should match key of identity.userAssignedIdentities. ,
Required: False ,
}
string ,
}
,
}
,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ElasticBackupVaults_Update (updated)
Description :  Patch the specified NetApp Elastic Backup Vault
Reference :  Link ¶

⚶ Changes

{
  "#id": "ElasticBackupVaults_Update",
  "$responses": {
    "202": [
      {
        "@added_01011d23e7db45d4b370e2a8a53f0208": {
          "#name": "azure-asyncoperation",
          "Description": "A link to the status monitor",
          "Type": "string"
        }
      }
    ]
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/elasticAccounts/{accountName}/elasticBackupVaults/{backupVaultName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the ElasticAccount ,
Required: True ,
}
string ,
backupVaultName:
{
Description: The name of the ElasticBackupVault ,
Required: True ,
}
string ,
body:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Azure lifecycle management. ,
Enum:
{
Accepted: Resource has been Accepted ,
Creating: Resource is being Created ,
Patching: Resource is being Patched ,
Updating: Resource is updating ,
Deleting: Resource is being Deleted ,
Moving: Resource is being Moved ,
Failed: Resource has Failed ,
Succeeded: Resource has Succeeded ,
}
,
Required: False ,
}
enum ,
}
,
eTag:
{
Description: If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ElasticBackups_Update (updated)
Description :  Patch an elastic Backup under the Elastic Backup Vault
Reference :  Link ¶

⚶ Changes

{
  "#id": "ElasticBackups_Update",
  "$responses": {
    "202": [
      {
        "@added_fd7e7d0b94904d758f9e268688c47cf5": {
          "#name": "azure-asyncoperation",
          "Description": "A link to the status monitor",
          "Type": "string"
        }
      }
    ]
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/elasticAccounts/{accountName}/elasticBackupVaults/{backupVaultName}/elasticBackups/{backupName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the ElasticAccount ,
Required: True ,
}
string ,
backupVaultName:
{
Description: The name of the ElasticBackupVault ,
Required: True ,
}
string ,
backupName:
{
Description: The name of the ElasticBackup ,
Required: True ,
}
string ,
body:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
label:
{
Description: Label for backup ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
creationDate:
{
Description: The creation date of the backup ,
Format: date-time ,
Required: False ,
}
string ,
snapshotCreationDate:
{
Description: The snapshot creation date of the backup ,
Format: date-time ,
Required: False ,
}
string ,
completionDate:
{
Description: The completion date of the backup ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Azure lifecycle management. ,
Enum:
{
Accepted: Resource has been Accepted ,
Creating: Resource is being Created ,
Patching: Resource is being Patched ,
Updating: Resource is updating ,
Deleting: Resource is being Deleted ,
Moving: Resource is being Moved ,
Failed: Resource has Failed ,
Succeeded: Resource has Succeeded ,
}
,
Required: False ,
}
enum ,
size:
{
Description: Size of backup in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
label:
{
Description: Label for backup ,
Required: False ,
}
string ,
backupType:
{
Description: Type of backup Manual or Scheduled ,
Enum:
{
Manual: Manual backup type ,
Scheduled: Scheduled backup type ,
}
,
Required: False ,
}
enum ,
failureReason:
{
Description: Failure reason ,
Required: False ,
}
string ,
elasticVolumeResourceId:
{
Description: ResourceId used to identify the Elastic Volume ,
Format: arm-id ,
Required: True ,
}
string ,
snapshotUsage:
{
Description: Manual backup using an already existing snapshot. This will always be CreateNewSnapshot for scheduled backups and UseExistingSnapshot/CreateNewSnapshot for manual backups ,
Enum:
{
UseExistingSnapshot: Value indicating an existing snapshot is used ,
CreateNewSnapshot: Value indicating a new snapshot is created ,
}
,
Required: False ,
}
enum ,
elasticSnapshotResourceId:
{
Description: ResourceId used to identify the elastic snapshot resource. This is required when an existing snapshot needs to be used for creating a manual backup ,
Format: arm-id ,
Required: False ,
}
string ,
elasticBackupPolicyResourceId:
{
Description: ResourceId used to identify the elastic backup policy ,
Format: arm-id ,
Required: False ,
}
string ,
volumeSize:
{
Description: Specifies if the backup is for a large volume. ,
Enum:
{
Large: Value indicating backup is for a large volume ,
Regular: Value indicating backup is not for a large volume ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ElasticCapacityPools_Update (updated)
Description :  Patch the specified NetApp Elastic Capacity Pool
Reference :  Link ¶

⚶ Changes

{
  "#id": "ElasticCapacityPools_Update",
  "$responses": {
    "202": [
      {
        "@added_a98069411c864114a009c66e3a244ebb": {
          "#name": "azure-asyncoperation",
          "Description": "A link to the status monitor",
          "Type": "string"
        }
      }
    ]
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/elasticAccounts/{accountName}/elasticCapacityPools/{poolName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the ElasticAccount ,
Required: True ,
}
string ,
poolName:
{
Description: The name of the ElasticCapacityPool ,
Required: True ,
}
string ,
body:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
size:
{
Description: Provisioned size of the pool (in bytes). For zoneRedundant service level pool, value must be in the range 1TiB to 16TiB or 1TiB to 128TiB for supported region. Values expressed in bytes as multiples of 1TiB till 16TiB and in multiples of 8TiB from 24TiB to 128TiB. Pool size can't be shrunk once it is created. ,
Format: int64 ,
Required: False ,
}
integer ,
encryption:
{
Description: Encryption settings ,
Required: False ,
}
{
elasticPoolEncryptionKeySource:
{
Description: Pool Encryption Key Source. ,
Enum:
{
NetApp: Represents the encryption key source of Elastic pool is Microsoft.NetApp ,
KeyVault: Represents the encryption key source of Elastic pool is Microsoft.KeyVault ,
}
,
Required: False ,
}
enum ,
keyVaultPrivateEndpointResourceId:
{
Description: The resource ID of private endpoint for KeyVault. It must reside in the same VNET as the volume. Only applicable if encryptionKeySource = 'Microsoft.KeyVault'. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
activeDirectoryConfigResourceId:
{
Description: The Azure Resource URI for an Active Directory configuration. This is used by all the SMB volumes within the pool ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
size:
{
Description: Provisioned size of the pool (in bytes). For zoneRedundant service level pool, value must be in the range 1TiB to 16TiB or 1TiB to 128TiB for supported region. Values expressed in bytes as multiples of 1TiB till 16TiB and in multiples of 8TiB from 24TiB to 128TiB. Pool size can't be shrunk once it is created. ,
Format: int64 ,
Required: True ,
}
integer ,
serviceLevel:
{
Description: The service level of the elastic capacity pool ,
Enum:
{
ZoneRedundant: Zone redundant storage service level. ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: Azure lifecycle management. ,
Enum:
{
Accepted: Resource has been Accepted ,
Creating: Resource is being Created ,
Patching: Resource is being Patched ,
Updating: Resource is updating ,
Deleting: Resource is being Deleted ,
Moving: Resource is being Moved ,
Failed: Resource has Failed ,
Succeeded: Resource has Succeeded ,
}
,
Required: False ,
}
enum ,
encryption:
{
Description: Encryption settings ,
Required: False ,
}
{
elasticPoolEncryptionKeySource:
{
Description: Pool Encryption Key Source. ,
Enum:
{
NetApp: Represents the encryption key source of Elastic pool is Microsoft.NetApp ,
KeyVault: Represents the encryption key source of Elastic pool is Microsoft.KeyVault ,
}
,
Required: True ,
}
enum ,
keyVaultPrivateEndpointResourceId:
{
Description: The resource ID of private endpoint for KeyVault. It must reside in the same VNET as the volume. Only applicable if encryptionKeySource = 'Microsoft.KeyVault'. ,
Format: arm-id ,
Required: True ,
}
string ,
}
,
totalThroughputMibps:
{
Description: Total throughput of the pool in MiB/s ,
Format: double ,
Required: False ,
}
number ,
subnetResourceId:
{
Description: The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/elasticVolumes, this is used by all the volumes within the pool ,
Format: arm-id ,
Required: True ,
}
string ,
currentZone:
{
Description: Indicates the current zone of the pool. This can be changed for zoneRedundant service level pool with the changeZone action ,
Required: False ,
}
string ,
availabilityStatus:
{
Description: Current availability status of the resource. ,
Enum:
{
Online: The resource is currently Online and accessible ,
Offline: The resource is currently Offline and not accessible ,
}
,
Required: False ,
}
enum ,
activeDirectoryConfigResourceId:
{
Description: The Azure Resource URI for an Active Directory configuration. This is used by all the SMB volumes within the pool ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
eTag:
{
Description: If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields. ,
Required: False ,
}
string ,
zones:
{
Description: The availability zones. ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ElasticVolumes_Update (updated)
Description :  Patch the specified elastic volume
Reference :  Link ¶

⚶ Changes

{
  "#id": "ElasticVolumes_Update",
  "$responses": {
    "202": [
      {
        "@added_bc875504f4144c1aa51c4bbae7b83239": {
          "#name": "azure-asyncoperation",
          "Description": "A link to the status monitor",
          "Type": "string"
        }
      }
    ]
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/elasticAccounts/{accountName}/elasticCapacityPools/{poolName}/elasticVolumes/{volumeName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the ElasticAccount ,
Required: True ,
}
string ,
poolName:
{
Description: The name of the ElasticCapacityPool ,
Required: True ,
}
string ,
volumeName:
{
Description: The name of the ElasticVolume ,
Required: True ,
}
string ,
body:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
size:
{
Description: Maximum size allowed for a volume in bytes. Valid values are in the range 1GiB to 16TiB. Values expressed in bytes as multiples of 1 GiB. ,
Format: int64 ,
Required: False ,
}
integer ,
exportPolicy:
{
Description: Set of export policy rules ,
Required: False ,
}
{
rules:
{
Description: Export policy rule ,
Required: False ,
}
[
{
ruleIndex:
{
Description: Controls the priority of the export policy rule. When connecting to the volume the rule with the lowest index that applies to the connecting client is used ,
Format: int32 ,
Required: False ,
}
integer ,
unixAccessRule:
{
Description: Specifies the Unix file access level for the volume. It encompasses both read-only and read-write permissions. Additionally, NoAccess can be set to block all access to the volume ,
Enum:
{
ReadOnly: Clients connecting with this rule will only have read access to the volume ,
ReadWrite: Clients connecting with this rule will have full read and write access to the volume ,
NoAccess: Clients connecting with this rule will have no access to the volume ,
}
,
Required: False ,
}
enum ,
nfsv3:
{
Description: Allows clients to access the volume with the NFSv3 protocol. Enable only for NFSv3 type volumes ,
Enum:
{
Enabled: Clients can connect to the volume using the NFSv3 protocol. ,
Disabled: Clients can't connect to the volume using the NFSv3 protocol. ,
}
,
Required: False ,
}
enum ,
nfsv4:
{
Description: Allows clients to access the volume with at least NFSv4.1 protocol. ,
Enum:
{
Enabled: Clients can connect to the volume using the NFSv4 protocol. ,
Disabled: Clients can't connect to the volume using the NFSv4 protocol. ,
}
,
Required: False ,
}
enum ,
allowedClients:
{
Description: Client ingress specification for the export policy as list of IPv4 CIDRs, IPv4 host addresses and host names. ,
Required: False ,
}
[
string ,
]
,
rootAccess:
{
Description: Indicates whether root access to the volume is granted to clients affected by this rule ,
Enum:
{
Enabled: Root user access is enabled for clients affected by this rule ,
Disabled: Root user access is disabled for clients affected by this rule ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
dataProtection:
{
Description: Data protection configuration option for the volume, including snapshot policies and backup. ,
Required: False ,
}
{
snapshot:
{
Description: Used to apply a snapshot policy to a volume. ,
Required: False ,
}
{
snapshotPolicyResourceId:
{
Description: Snapshot Policy ResourceId ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
backup:
{
Description: Used to configure backups on an elastic volume. ,
Required: False ,
}
{
elasticBackupPolicyResourceId:
{
Description: ResourceId used to identify Elastic Backup Policy ,
Format: arm-id ,
Required: False ,
}
string ,
policyEnforcement:
{
Description: The property to decide policy is enforced or not on the volume ,
Enum:
{
Enforced: Value indicating the policy is enforced on the volume. ,
NotEnforced: Value indicating the policy is not enforced on the volume. ,
}
,
Required: False ,
}
enum ,
elasticBackupVaultResourceId:
{
Description: ResourceId used to identify Elastic Backup Vault ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
snapshotDirectoryVisibility:
{
Description: Controls the visibility of the volume's read-only snapshot directory, which provides access to each of the volume's snapshots. ,
Enum:
{
Hidden: Value indicating the read-only snapshot directory is not visible ,
Visible: Value indicating the read-only snapshot directory is visible ,
}
,
Required: False ,
}
enum ,
smbProperties:
{
Description: SMB Properties ,
Required: False ,
}
{
smbEncryption:
{
Description: Used to enable or disable encryption for in-flight SMB data volume. This flag can be modified during Elastic volume update operation as well. Only applicable for SMB protocol Elastic volumes. ,
Enum:
{
Enabled: Value indicating the SMB encryption is enabled ,
Disabled: Value indicating the SMB encryption is disabled ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
filePath:
{
Description: A unique file path for the volume. Used when creating mount targets. This needs to be unique within the elastic capacity pool. ,
Required: True ,
}
string ,
size:
{
Description: Maximum size allowed for a volume in bytes. Valid values are in the range 1GiB to 16TiB. Values expressed in bytes as multiples of 1 GiB. ,
Format: int64 ,
Required: True ,
}
integer ,
exportPolicy:
{
Description: Set of export policy rules ,
Required: False ,
}
{
rules:
{
Description: Export policy rule ,
Required: False ,
}
[
{
ruleIndex:
{
Description: Controls the priority of the export policy rule. When connecting to the volume the rule with the lowest index that applies to the connecting client is used ,
Format: int32 ,
Required: False ,
}
integer ,
unixAccessRule:
{
Description: Specifies the Unix file access level for the volume. It encompasses both read-only and read-write permissions. Additionally, NoAccess can be set to block all access to the volume ,
Enum:
{
ReadOnly: Clients connecting with this rule will only have read access to the volume ,
ReadWrite: Clients connecting with this rule will have full read and write access to the volume ,
NoAccess: Clients connecting with this rule will have no access to the volume ,
}
,
Required: False ,
}
enum ,
nfsv3:
{
Description: Allows clients to access the volume with the NFSv3 protocol. Enable only for NFSv3 type volumes ,
Enum:
{
Enabled: Clients can connect to the volume using the NFSv3 protocol. ,
Disabled: Clients can't connect to the volume using the NFSv3 protocol. ,
}
,
Required: False ,
}
enum ,
nfsv4:
{
Description: Allows clients to access the volume with at least NFSv4.1 protocol. ,
Enum:
{
Enabled: Clients can connect to the volume using the NFSv4 protocol. ,
Disabled: Clients can't connect to the volume using the NFSv4 protocol. ,
}
,
Required: False ,
}
enum ,
allowedClients:
{
Description: Client ingress specification for the export policy as list of IPv4 CIDRs, IPv4 host addresses and host names. ,
Required: False ,
}
[
string ,
]
,
rootAccess:
{
Description: Indicates whether root access to the volume is granted to clients affected by this rule ,
Enum:
{
Enabled: Root user access is enabled for clients affected by this rule ,
Disabled: Root user access is disabled for clients affected by this rule ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
protocolTypes:
{
Description: Set of support protocol types for the elastic volume ,
Required: True ,
}
[
string ,
]
,
provisioningState:
{
Description: Azure lifecycle management. ,
Enum:
{
Accepted: Resource has been Accepted ,
Creating: Resource is being Created ,
Patching: Resource is being Patched ,
Updating: Resource is updating ,
Deleting: Resource is being Deleted ,
Moving: Resource is being Moved ,
Failed: Resource has Failed ,
Succeeded: Resource has Succeeded ,
}
,
Required: False ,
}
enum ,
availabilityStatus:
{
Description: Current availability status of the resource. ,
Enum:
{
Online: The resource is currently Online and accessible ,
Offline: The resource is currently Offline and not accessible ,
}
,
Required: False ,
}
enum ,
snapshotResourceId:
{
Description: Resource identifier used to identify the Elastic Snapshot. ,
Format: arm-id ,
Required: False ,
}
string ,
mountTargets:
{
Description: List of mount targets that can be used to mount this volume ,
Required: False ,
}
[
{
ipAddress:
{
Description: The mount target's IPv4 address, used to mount the volume ,
Required: False ,
}
string ,
smbServerFqdn:
{
Description: The SMB server's Fully Qualified Domain Name, FQDN ,
Required: False ,
}
string ,
}
,
]
,
dataProtection:
{
Description: Data protection configuration option for the volume, including snapshot policies and backup. ,
Required: False ,
}
{
snapshot:
{
Description: Used to apply a snapshot policy to a volume. ,
Required: False ,
}
{
snapshotPolicyResourceId:
{
Description: Snapshot Policy ResourceId ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
backup:
{
Description: Used to configure backups on an elastic volume. ,
Required: False ,
}
{
elasticBackupPolicyResourceId:
{
Description: ResourceId used to identify Elastic Backup Policy ,
Format: arm-id ,
Required: False ,
}
string ,
policyEnforcement:
{
Description: The property to decide policy is enforced or not on the volume ,
Enum:
{
Enforced: Value indicating the policy is enforced on the volume. ,
NotEnforced: Value indicating the policy is not enforced on the volume. ,
}
,
Required: False ,
}
enum ,
elasticBackupVaultResourceId:
{
Description: ResourceId used to identify Elastic Backup Vault ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
snapshotDirectoryVisibility:
{
Description: Controls the visibility of the volume's read-only snapshot directory, which provides access to each of the volume's snapshots. ,
Enum:
{
Hidden: Value indicating the read-only snapshot directory is not visible ,
Visible: Value indicating the read-only snapshot directory is visible ,
}
,
Required: False ,
}
enum ,
smbProperties:
{
Description: SMB Properties ,
Required: False ,
}
{
smbEncryption:
{
Description: Used to enable or disable encryption for in-flight SMB data volume. This flag can be modified during Elastic volume update operation as well. Only applicable for SMB protocol Elastic volumes. ,
Enum:
{
Enabled: Value indicating the SMB encryption is enabled ,
Disabled: Value indicating the SMB encryption is disabled ,
}
,
Required: False ,
}
enum ,
}
,
backupResourceId:
{
Description: Resource identifier used to identify the Elastic Backup. ,
Format: arm-id ,
Required: False ,
}
string ,
restorationState:
{
Description: The current state of the restoration process. ,
Enum:
{
Restoring: Value indicating that the volume is currently restoring. ,
Restored: Value indicating that the volume is restored. ,
Failed: Value indicating that the volume restore has failed. ,
}
,
Required: False ,
}
enum ,
}
,
eTag:
{
Description: If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields. ,
Required: False ,
}
string ,
zones:
{
Description: The availability zones. ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ElasticSnapshotPolicies_Update (updated)
Description :  Update a ElasticSnapshotPolicy
Reference :  Link ¶

⚶ Changes

{
  "#id": "ElasticSnapshotPolicies_Update",
  "$responses": {
    "202": [
      {
        "@added_915331b75e90497cb8eba471e11fb55b": {
          "#name": "azure-asyncoperation",
          "Description": "A link to the status monitor",
          "Type": "string"
        }
      }
    ]
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/elasticAccounts/{accountName}/elasticSnapshotPolicies/{snapshotPolicyName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the ElasticAccount ,
Required: True ,
}
string ,
snapshotPolicyName:
{
Description: The name of the ElasticSnapshotPolicy ,
Required: True ,
}
string ,
body:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
hourlySchedule:
{
Description: Schedule for hourly snapshots ,
Required: False ,
}
{
snapshotsToKeep:
{
Description: Hourly snapshot count to keep ,
Format: int32 ,
Required: False ,
}
integer ,
minute:
{
Description: Indicates which minute snapshot should be taken ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dailySchedule:
{
Description: Schedule for daily snapshots ,
Required: False ,
}
{
snapshotsToKeep:
{
Description: Daily snapshot count to keep ,
Format: int32 ,
Required: False ,
}
integer ,
hour:
{
Description: Indicates which hour in UTC timezone a snapshot should be taken ,
Format: int32 ,
Required: False ,
}
integer ,
minute:
{
Description: Indicates which minute snapshot should be taken ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
weeklySchedule:
{
Description: Schedule for weekly snapshots ,
Required: False ,
}
{
snapshotsToKeep:
{
Description: Weekly snapshot count to keep ,
Format: int32 ,
Required: False ,
}
integer ,
days:
{
Description: Indicates which weekday(s) snapshot(s) should be taken, accepts a list of week day names in english ,
Required: False ,
}
[
string ,
]
,
hour:
{
Description: Indicates which hour in UTC timezone a snapshot should be taken ,
Format: int32 ,
Required: False ,
}
integer ,
minute:
{
Description: Indicates which minute snapshot should be taken ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
monthlySchedule:
{
Description: Schedule for monthly snapshots ,
Required: False ,
}
{
snapshotsToKeep:
{
Description: Monthly snapshot count to keep ,
Format: int32 ,
Required: False ,
}
integer ,
daysOfMonth:
{
Description: Indicates which days of the month snapshot (1-31) should be taken, accepts a list of integers ,
Required: False ,
}
[
integer ,
]
,
hour:
{
Description: Indicates which hour in UTC timezone a snapshot should be taken ,
Format: int32 ,
Required: False ,
}
integer ,
minute:
{
Description: Indicates which minute snapshot should be taken ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
policyStatus:
{
Description: Configures if the snapshot policy is enabled on the volumes connected to the policy. ,
Enum:
{
Enabled: Value indicating the policy is enabled ,
Disabled: Value indicating the policy is disabled ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
hourlySchedule:
{
Description: Schedule for hourly snapshots ,
Required: False ,
}
{
snapshotsToKeep:
{
Description: Hourly snapshot count to keep ,
Format: int32 ,
Required: False ,
}
integer ,
minute:
{
Description: Indicates which minute snapshot should be taken ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dailySchedule:
{
Description: Schedule for daily snapshots ,
Required: False ,
}
{
snapshotsToKeep:
{
Description: Daily snapshot count to keep ,
Format: int32 ,
Required: False ,
}
integer ,
hour:
{
Description: Indicates which hour in UTC timezone a snapshot should be taken ,
Format: int32 ,
Required: False ,
}
integer ,
minute:
{
Description: Indicates which minute snapshot should be taken ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
weeklySchedule:
{
Description: Schedule for weekly snapshots ,
Required: False ,
}
{
snapshotsToKeep:
{
Description: Weekly snapshot count to keep ,
Format: int32 ,
Required: False ,
}
integer ,
days:
{
Description: Indicates which weekday(s) snapshot(s) should be taken, accepts a list of week day names in english ,
Required: False ,
}
[
string ,
]
,
hour:
{
Description: Indicates which hour in UTC timezone a snapshot should be taken ,
Format: int32 ,
Required: False ,
}
integer ,
minute:
{
Description: Indicates which minute snapshot should be taken ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
monthlySchedule:
{
Description: Schedule for monthly snapshots ,
Required: False ,
}
{
snapshotsToKeep:
{
Description: Monthly snapshot count to keep ,
Format: int32 ,
Required: False ,
}
integer ,
daysOfMonth:
{
Description: Indicates which days of the month snapshot (1-31) should be taken, accepts a list of integers ,
Required: False ,
}
[
integer ,
]
,
hour:
{
Description: Indicates which hour in UTC timezone a snapshot should be taken ,
Format: int32 ,
Required: False ,
}
integer ,
minute:
{
Description: Indicates which minute snapshot should be taken ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
policyStatus:
{
Description: Configures if the snapshot policy is enabled on the volumes connected to the policy. ,
Enum:
{
Enabled: Value indicating the policy is enabled ,
Disabled: Value indicating the policy is disabled ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Azure lifecycle management. ,
Enum:
{
Accepted: Resource has been Accepted ,
Creating: Resource is being Created ,
Patching: Resource is being Patched ,
Updating: Resource is updating ,
Deleting: Resource is being Deleted ,
Moving: Resource is being Moved ,
Failed: Resource has Failed ,
Succeeded: Resource has Succeeded ,
}
,
Required: False ,
}
enum ,
}
,
eTag:
{
Description: If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Caches_ListByCapacityPools (updated)
Description :  List all Caches within the Capacity Pool
Reference :  Link ¶

⚶ Changes

{
  "#id": "Caches_ListByCapacityPools",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "#name": "exportPolicy",
                "Type": {
                  "new": "object",
                  "old": "array"
                }
              },
              {
                "#name": "protocolTypes",
                "Description": {
                  "new": "Set of supported protocol types, which include NFSv3, NFSv4 and SMB protocol",
                  "old": "Set of protocol types, default NFSv3, CIFS for SMB protocol"
                },
                "$items": {
                  "Description": {
                    "new": "Set of supported protocol types, which include NFSv3, NFSv4 and SMB protocol",
                    "old": "Export policy rule"
                  }
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/caches
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the NetApp account ,
Required: True ,
}
string ,
poolName:
{
Description: The name of the capacity pool ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Cache items on this page ,
Required: True ,
}
[
{
properties:
{
Description: Cache properties ,
Required: True ,
}
{
filepath:
{
Description: The file path of the Cache. ,
Required: True ,
}
string ,
size:
{
Description: Maximum storage quota allowed for a file system in bytes. Valid values are in the range 50GiB to 1PiB. Values expressed in bytes as multiples of 1GiB. ,
Format: int64 ,
Required: True ,
}
integer ,
exportPolicy:
{
Description: Set of export policy rules ,
Required: False ,
}
{
rules:
{
Description: Export policy rule ,
Required: False ,
}
[
{
ruleIndex:
{
Description: Order index ,
Format: int32 ,
Required: False ,
}
integer ,
unixReadOnly:
{
Description: Read only access ,
Required: False ,
}
boolean ,
unixReadWrite:
{
Description: Read and write access ,
Required: False ,
}
boolean ,
kerberos5ReadOnly:
{
Description: Kerberos5 Read only access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5ReadWrite:
{
Description: Kerberos5 Read and write access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5iReadOnly:
{
Description: Kerberos5i Read only access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5iReadWrite:
{
Description: Kerberos5i Read and write access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5pReadOnly:
{
Description: Kerberos5p Read only access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5pReadWrite:
{
Description: Kerberos5p Read and write access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
cifs:
{
Description: Allows CIFS protocol ,
Required: False ,
}
boolean ,
nfsv3:
{
Description: Allows NFSv3 protocol. Enable only for NFSv3 type volumes ,
Required: False ,
}
boolean ,
nfsv41:
{
Description: Allows NFSv4.1 protocol. Enable only for NFSv4.1 type volumes ,
Required: False ,
}
boolean ,
allowedClients:
{
Description: Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names ,
Required: False ,
}
string ,
hasRootAccess:
{
Description: Has root access to volume ,
Required: False ,
}
boolean ,
chownMode:
{
Description: This parameter specifies who is authorized to change the ownership of a file. restricted - Only root user can change the ownership of the file. unrestricted - Non-root users can change ownership of files that they own. ,
Enum:
{
Restricted: No description available. ,
Unrestricted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
protocolTypes:
{
Description: Set of supported protocol types, which include NFSv3, NFSv4 and SMB protocol ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: Azure lifecycle management ,
Enum:
{
Creating: The resource is being created. ,
Updating: The resource is being updated. ,
Deleting: The resource is being deleted. ,
Failed: The resource is in a failed state. ,
Succeeded: The resource is succeeded. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
cacheState:
{
Description: Azure NetApp Files Cache lifecycle management ,
Enum:
{
ClusterPeeringOfferSent: Cluster peering offer has been sent. ,
VserverPeeringOfferSent: VServer peering offer has been sent. ,
Creating: Cache creation in progress. ,
Succeeded: Cache creation succeeded and is available for use. ,
Failed: Cache is in a failed state ,
}
,
Required: False ,
}
enum ,
cacheSubnetResourceId:
{
Description: The Azure Resource URI for a delegated cache subnet that will be used to allocate data IPs. ,
Format: arm-id ,
Required: True ,
}
string ,
peeringSubnetResourceId:
{
Description: The Azure Resource URI for a delegated subnet that will be used for ANF Intercluster Interface IP addresses. ,
Format: arm-id ,
Required: True ,
}
string ,
mountTargets:
{
Description: List of mount targets that can be used to mount this cache ,
Required: False ,
}
[
{
mountTargetId:
{
Description: UUID v4 used to identify the MountTarget ,
Required: False ,
}
string ,
ipAddress:
{
Description: The mount target's IPv4 address, used to mount the cache. ,
Required: False ,
}
string ,
smbServerFqdn:
{
Description: The SMB server's Fully Qualified Domain Name, FQDN ,
Required: False ,
}
string ,
}
,
]
,
kerberos:
{
Description: Describe if a cache is Kerberos enabled. ,
Enum:
{
Disabled: Kerberos is disabled ,
Enabled: Kerberos is enabled ,
}
,
Required: False ,
}
enum ,
smbSettings:
{
Description: SMB information for the cache ,
Required: False ,
}
{
smbEncryption:
{
Description: Enables encryption for in-flight smb3 data. Only applicable for SMB/DualProtocol cache. ,
Enum:
{
Disabled: SMB encryption is disabled ,
Enabled: SMB encryption is enabled ,
}
,
Required: False ,
}
enum ,
smbAccessBasedEnumerations:
{
Description: Enables access-based enumeration share property for SMB Shares. Only applicable for SMB/DualProtocol volume ,
Enum:
{
Disabled: smbAccessBasedEnumeration share setting is disabled ,
Enabled: smbAccessBasedEnumeration share setting is enabled ,
}
,
Required: False ,
}
enum ,
smbNonBrowsable:
{
Description: Enables non-browsable property for SMB Shares. Only applicable for SMB/DualProtocol volume ,
Enum:
{
Disabled: smbNonBrowsable share setting is disabled ,
Enabled: smbNonBrowsable share setting is enabled ,
}
,
Required: False ,
}
enum ,
}
,
throughputMibps:
{
Description: Maximum throughput in MiB/s that can be achieved by this cache volume and this will be accepted as input only for manual qosType cache ,
Format: float ,
Required: False ,
}
number ,
actualThroughputMibps:
{
Description: Actual throughput in MiB/s for auto qosType volumes calculated based on size and serviceLevel ,
Format: float ,
Required: False ,
}
number ,
encryptionKeySource:
{
Description: Source of key used to encrypt data in the cache. Applicable if NetApp account has encryption.keySource = 'Microsoft.KeyVault'. Possible values (case-insensitive) are: 'Microsoft.NetApp, Microsoft.KeyVault' ,
Enum:
{
Microsoft.NetApp: Microsoft-managed key encryption ,
Microsoft.KeyVault: Customer-managed key encryption ,
}
,
Required: True ,
}
enum ,
keyVaultPrivateEndpointResourceId:
{
Description: The resource ID of private endpoint for KeyVault. It must reside in the same VNET as the volume. Only applicable if encryptionKeySource = 'Microsoft.KeyVault'. ,
Format: arm-id ,
Required: False ,
}
string ,
maximumNumberOfFiles:
{
Description: Maximum number of files allowed. ,
Format: int64 ,
Required: False ,
}
integer ,
encryption:
{
Description: Specifies if the cache is encryption or not. ,
Enum:
{
Disabled: Encryption is disabled ,
Enabled: Encryption is enabled ,
}
,
Required: False ,
}
enum ,
language:
{
Description: Language supported for volume. ,
Enum:
{
c.utf-8: Posix with UTF-8 ,
utf8mb4: UTF-8 with 4 byte character support ,
ar: Arabic - Deprecated ,
ar.utf-8: Arabic with UTF-8 ,
hr: Croatian - Deprecated ,
hr.utf-8: Croatian with UTF-8 ,
cs: Czech - Deprecated ,
cs.utf-8: Czech with UTF-8 ,
da: Danish - Deprecated ,
da.utf-8: Danish with UTF-8 ,
nl: Dutch - Deprecated ,
nl.utf-8: Dutch with UTF-8 ,
en: English - Deprecated ,
en.utf-8: English with UTF-8 ,
fi: Finnish - Deprecated ,
fi.utf-8: Finnish with UTF-8 ,
fr: French - Deprecated ,
fr.utf-8: French with UTF-8 ,
de: German - Deprecated ,
de.utf-8: German with UTF-8 ,
he: Hebrew - Deprecated ,
he.utf-8: Hebrew with UTF-8 ,
hu: Hungarian - Deprecated ,
hu.utf-8: Hungarian with UTF-8 ,
it: Italian - Deprecated ,
it.utf-8: Italian with UTF-8 ,
ja: Japanese euc-j - Deprecated ,
ja.utf-8: Japanese euc-j with UTF-8 ,
ja-v1: Japanese euc-j - Deprecated ,
ja-v1.utf-8: Japanese euc-j with UTF-8 ,
ja-jp.pck: Japanese pck ,
ja-jp.pck.utf-8: Japanese pck with UTF-8 - Deprecated ,
ja-jp.932: Japanese cp932 ,
ja-jp.932.utf-8: Japanese cp932 with UTF-8 - Deprecated ,
ja-jp.pck-v2: Japanese pck - sjis ,
ja-jp.pck-v2.utf-8: Japanese pck - sjis with UTF-8 - Deprecated ,
ko: Korean - Deprecated ,
ko.utf-8: Korean with UTF-8 ,
no: Norwegian - Deprecated ,
no.utf-8: Norwegian with UTF-8 ,
pl: Polish - Deprecated ,
pl.utf-8: Polish with UTF-8 ,
pt: Portuguese - Deprecated ,
pt.utf-8: Portuguese with UTF-8 ,
c: Posix - Deprecated ,
ro: Romanian - Deprecated ,
ro.utf-8: Romanian with UTF-8 ,
ru: Russian - Deprecated ,
ru.utf-8: Russian with UTF-8 ,
zh: Simplified Chinese - Deprecated ,
zh.utf-8: Simplified Chinese with UTF-8 ,
zh.gbk: Simplified gbk Chinese ,
zh.gbk.utf-8: Simplified gbk Chinese with UTF-8 - Deprecated ,
zh-tw.big5: Traditional Chinese BIG 5 ,
zh-tw.big5.utf-8: Traditional Chinese BIG 5 with UTF-8 - Deprecated ,
zh-tw: Traditional Chinese EUC-TW ,
zh-tw.utf-8: Traditional Chinese EUC-TW with UTF-8 - Deprecated ,
sk: Slovak - Deprecated ,
sk.utf-8: Slovak with UTF-8 ,
sl: Slovenian - Deprecated ,
sl.utf-8: Slovenian with UTF-8 ,
es: Spanish - Deprecated ,
es.utf-8: Spanish with UTF-8 ,
sv: Swedish - Deprecated ,
sv.utf-8: Swedish with UTF-8 ,
tr: Turkish - Deprecated ,
tr.utf-8: Turkish with UTF-8 ,
en-us: US English - Deprecated ,
en-us.utf-8: US English with UTF-8 ,
}
,
Required: False ,
}
enum ,
ldap:
{
Description: Specifies whether LDAP is enabled or not for flexcache volume. ,
Enum:
{
Disabled: ldap is disabled. ,
Enabled: ldap is enabled ,
}
,
Required: False ,
}
enum ,
ldapServerType:
{
Description: Specifies the type of LDAP server for flexcache volume. ,
Enum:
{
ActiveDirectory: The volume should use Active Directory for LDAP connections. ,
OpenLDAP: The volume should use OpenLDAP for LDAP connections. ,
}
,
Required: False ,
}
enum ,
originClusterInformation:
{
Description: Origin cluster information ,
Required: True ,
}
{
peerClusterName:
{
Description: ONTAP cluster name of external cluster hosting the origin volume ,
Required: True ,
}
string ,
peerAddresses:
{
Description: ONTAP Intercluster LIF IP addresses. One IP address per cluster node is required ,
Required: True ,
}
[
string ,
]
,
peerVserverName:
{
Description: External Vserver (SVM) name name of the SVM hosting the origin volume ,
Required: True ,
}
string ,
peerVolumeName:
{
Description: External origin volume name associated to this cache ,
Required: True ,
}
string ,
}
,
cifsChangeNotifications:
{
Description: Flag indicating whether a CIFS change notification is enabled for the cache. ,
Enum:
{
Disabled: CIFS change notification is disabled ,
Enabled: CIFS change notification is enabled ,
}
,
Required: False ,
}
enum ,
globalFileLocking:
{
Description: Flag indicating whether the global file lock is enabled for the cache. ,
Enum:
{
Disabled: Global file locking is disabled ,
Enabled: Global file locking is enabled ,
}
,
Required: False ,
}
enum ,
writeBack:
{
Description: Flag indicating whether writeback is enabled for the cache. ,
Enum:
{
Disabled: Writeback cache is disabled ,
Enabled: Writeback cache is enabled ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
zones:
{
Description: The availability zones. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Caches_Get (updated)
Description :  Get the details of the specified Cache
Reference :  Link ¶

⚶ Changes

{
  "#id": "Caches_Get",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "exportPolicy",
            "Type": {
              "new": "object",
              "old": "array"
            }
          },
          {
            "#name": "protocolTypes",
            "Description": {
              "new": "Set of supported protocol types, which include NFSv3, NFSv4 and SMB protocol",
              "old": "Set of protocol types, default NFSv3, CIFS for SMB protocol"
            },
            "$items": {
              "Description": {
                "new": "Set of supported protocol types, which include NFSv3, NFSv4 and SMB protocol",
                "old": "Export policy rule"
              }
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/caches/{cacheName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the NetApp account ,
Required: True ,
}
string ,
poolName:
{
Description: The name of the capacity pool ,
Required: True ,
}
string ,
cacheName:
{
Description: The name of the cache resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Cache properties ,
Required: True ,
}
{
filepath:
{
Description: The file path of the Cache. ,
Required: True ,
}
string ,
size:
{
Description: Maximum storage quota allowed for a file system in bytes. Valid values are in the range 50GiB to 1PiB. Values expressed in bytes as multiples of 1GiB. ,
Format: int64 ,
Required: True ,
}
integer ,
exportPolicy:
{
Description: Set of export policy rules ,
Required: False ,
}
{
rules:
{
Description: Export policy rule ,
Required: False ,
}
[
{
ruleIndex:
{
Description: Order index ,
Format: int32 ,
Required: False ,
}
integer ,
unixReadOnly:
{
Description: Read only access ,
Required: False ,
}
boolean ,
unixReadWrite:
{
Description: Read and write access ,
Required: False ,
}
boolean ,
kerberos5ReadOnly:
{
Description: Kerberos5 Read only access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5ReadWrite:
{
Description: Kerberos5 Read and write access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5iReadOnly:
{
Description: Kerberos5i Read only access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5iReadWrite:
{
Description: Kerberos5i Read and write access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5pReadOnly:
{
Description: Kerberos5p Read only access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5pReadWrite:
{
Description: Kerberos5p Read and write access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
cifs:
{
Description: Allows CIFS protocol ,
Required: False ,
}
boolean ,
nfsv3:
{
Description: Allows NFSv3 protocol. Enable only for NFSv3 type volumes ,
Required: False ,
}
boolean ,
nfsv41:
{
Description: Allows NFSv4.1 protocol. Enable only for NFSv4.1 type volumes ,
Required: False ,
}
boolean ,
allowedClients:
{
Description: Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names ,
Required: False ,
}
string ,
hasRootAccess:
{
Description: Has root access to volume ,
Required: False ,
}
boolean ,
chownMode:
{
Description: This parameter specifies who is authorized to change the ownership of a file. restricted - Only root user can change the ownership of the file. unrestricted - Non-root users can change ownership of files that they own. ,
Enum:
{
Restricted: No description available. ,
Unrestricted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
protocolTypes:
{
Description: Set of supported protocol types, which include NFSv3, NFSv4 and SMB protocol ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: Azure lifecycle management ,
Enum:
{
Creating: The resource is being created. ,
Updating: The resource is being updated. ,
Deleting: The resource is being deleted. ,
Failed: The resource is in a failed state. ,
Succeeded: The resource is succeeded. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
cacheState:
{
Description: Azure NetApp Files Cache lifecycle management ,
Enum:
{
ClusterPeeringOfferSent: Cluster peering offer has been sent. ,
VserverPeeringOfferSent: VServer peering offer has been sent. ,
Creating: Cache creation in progress. ,
Succeeded: Cache creation succeeded and is available for use. ,
Failed: Cache is in a failed state ,
}
,
Required: False ,
}
enum ,
cacheSubnetResourceId:
{
Description: The Azure Resource URI for a delegated cache subnet that will be used to allocate data IPs. ,
Format: arm-id ,
Required: True ,
}
string ,
peeringSubnetResourceId:
{
Description: The Azure Resource URI for a delegated subnet that will be used for ANF Intercluster Interface IP addresses. ,
Format: arm-id ,
Required: True ,
}
string ,
mountTargets:
{
Description: List of mount targets that can be used to mount this cache ,
Required: False ,
}
[
{
mountTargetId:
{
Description: UUID v4 used to identify the MountTarget ,
Required: False ,
}
string ,
ipAddress:
{
Description: The mount target's IPv4 address, used to mount the cache. ,
Required: False ,
}
string ,
smbServerFqdn:
{
Description: The SMB server's Fully Qualified Domain Name, FQDN ,
Required: False ,
}
string ,
}
,
]
,
kerberos:
{
Description: Describe if a cache is Kerberos enabled. ,
Enum:
{
Disabled: Kerberos is disabled ,
Enabled: Kerberos is enabled ,
}
,
Required: False ,
}
enum ,
smbSettings:
{
Description: SMB information for the cache ,
Required: False ,
}
{
smbEncryption:
{
Description: Enables encryption for in-flight smb3 data. Only applicable for SMB/DualProtocol cache. ,
Enum:
{
Disabled: SMB encryption is disabled ,
Enabled: SMB encryption is enabled ,
}
,
Required: False ,
}
enum ,
smbAccessBasedEnumerations:
{
Description: Enables access-based enumeration share property for SMB Shares. Only applicable for SMB/DualProtocol volume ,
Enum:
{
Disabled: smbAccessBasedEnumeration share setting is disabled ,
Enabled: smbAccessBasedEnumeration share setting is enabled ,
}
,
Required: False ,
}
enum ,
smbNonBrowsable:
{
Description: Enables non-browsable property for SMB Shares. Only applicable for SMB/DualProtocol volume ,
Enum:
{
Disabled: smbNonBrowsable share setting is disabled ,
Enabled: smbNonBrowsable share setting is enabled ,
}
,
Required: False ,
}
enum ,
}
,
throughputMibps:
{
Description: Maximum throughput in MiB/s that can be achieved by this cache volume and this will be accepted as input only for manual qosType cache ,
Format: float ,
Required: False ,
}
number ,
actualThroughputMibps:
{
Description: Actual throughput in MiB/s for auto qosType volumes calculated based on size and serviceLevel ,
Format: float ,
Required: False ,
}
number ,
encryptionKeySource:
{
Description: Source of key used to encrypt data in the cache. Applicable if NetApp account has encryption.keySource = 'Microsoft.KeyVault'. Possible values (case-insensitive) are: 'Microsoft.NetApp, Microsoft.KeyVault' ,
Enum:
{
Microsoft.NetApp: Microsoft-managed key encryption ,
Microsoft.KeyVault: Customer-managed key encryption ,
}
,
Required: True ,
}
enum ,
keyVaultPrivateEndpointResourceId:
{
Description: The resource ID of private endpoint for KeyVault. It must reside in the same VNET as the volume. Only applicable if encryptionKeySource = 'Microsoft.KeyVault'. ,
Format: arm-id ,
Required: False ,
}
string ,
maximumNumberOfFiles:
{
Description: Maximum number of files allowed. ,
Format: int64 ,
Required: False ,
}
integer ,
encryption:
{
Description: Specifies if the cache is encryption or not. ,
Enum:
{
Disabled: Encryption is disabled ,
Enabled: Encryption is enabled ,
}
,
Required: False ,
}
enum ,
language:
{
Description: Language supported for volume. ,
Enum:
{
c.utf-8: Posix with UTF-8 ,
utf8mb4: UTF-8 with 4 byte character support ,
ar: Arabic - Deprecated ,
ar.utf-8: Arabic with UTF-8 ,
hr: Croatian - Deprecated ,
hr.utf-8: Croatian with UTF-8 ,
cs: Czech - Deprecated ,
cs.utf-8: Czech with UTF-8 ,
da: Danish - Deprecated ,
da.utf-8: Danish with UTF-8 ,
nl: Dutch - Deprecated ,
nl.utf-8: Dutch with UTF-8 ,
en: English - Deprecated ,
en.utf-8: English with UTF-8 ,
fi: Finnish - Deprecated ,
fi.utf-8: Finnish with UTF-8 ,
fr: French - Deprecated ,
fr.utf-8: French with UTF-8 ,
de: German - Deprecated ,
de.utf-8: German with UTF-8 ,
he: Hebrew - Deprecated ,
he.utf-8: Hebrew with UTF-8 ,
hu: Hungarian - Deprecated ,
hu.utf-8: Hungarian with UTF-8 ,
it: Italian - Deprecated ,
it.utf-8: Italian with UTF-8 ,
ja: Japanese euc-j - Deprecated ,
ja.utf-8: Japanese euc-j with UTF-8 ,
ja-v1: Japanese euc-j - Deprecated ,
ja-v1.utf-8: Japanese euc-j with UTF-8 ,
ja-jp.pck: Japanese pck ,
ja-jp.pck.utf-8: Japanese pck with UTF-8 - Deprecated ,
ja-jp.932: Japanese cp932 ,
ja-jp.932.utf-8: Japanese cp932 with UTF-8 - Deprecated ,
ja-jp.pck-v2: Japanese pck - sjis ,
ja-jp.pck-v2.utf-8: Japanese pck - sjis with UTF-8 - Deprecated ,
ko: Korean - Deprecated ,
ko.utf-8: Korean with UTF-8 ,
no: Norwegian - Deprecated ,
no.utf-8: Norwegian with UTF-8 ,
pl: Polish - Deprecated ,
pl.utf-8: Polish with UTF-8 ,
pt: Portuguese - Deprecated ,
pt.utf-8: Portuguese with UTF-8 ,
c: Posix - Deprecated ,
ro: Romanian - Deprecated ,
ro.utf-8: Romanian with UTF-8 ,
ru: Russian - Deprecated ,
ru.utf-8: Russian with UTF-8 ,
zh: Simplified Chinese - Deprecated ,
zh.utf-8: Simplified Chinese with UTF-8 ,
zh.gbk: Simplified gbk Chinese ,
zh.gbk.utf-8: Simplified gbk Chinese with UTF-8 - Deprecated ,
zh-tw.big5: Traditional Chinese BIG 5 ,
zh-tw.big5.utf-8: Traditional Chinese BIG 5 with UTF-8 - Deprecated ,
zh-tw: Traditional Chinese EUC-TW ,
zh-tw.utf-8: Traditional Chinese EUC-TW with UTF-8 - Deprecated ,
sk: Slovak - Deprecated ,
sk.utf-8: Slovak with UTF-8 ,
sl: Slovenian - Deprecated ,
sl.utf-8: Slovenian with UTF-8 ,
es: Spanish - Deprecated ,
es.utf-8: Spanish with UTF-8 ,
sv: Swedish - Deprecated ,
sv.utf-8: Swedish with UTF-8 ,
tr: Turkish - Deprecated ,
tr.utf-8: Turkish with UTF-8 ,
en-us: US English - Deprecated ,
en-us.utf-8: US English with UTF-8 ,
}
,
Required: False ,
}
enum ,
ldap:
{
Description: Specifies whether LDAP is enabled or not for flexcache volume. ,
Enum:
{
Disabled: ldap is disabled. ,
Enabled: ldap is enabled ,
}
,
Required: False ,
}
enum ,
ldapServerType:
{
Description: Specifies the type of LDAP server for flexcache volume. ,
Enum:
{
ActiveDirectory: The volume should use Active Directory for LDAP connections. ,
OpenLDAP: The volume should use OpenLDAP for LDAP connections. ,
}
,
Required: False ,
}
enum ,
originClusterInformation:
{
Description: Origin cluster information ,
Required: True ,
}
{
peerClusterName:
{
Description: ONTAP cluster name of external cluster hosting the origin volume ,
Required: True ,
}
string ,
peerAddresses:
{
Description: ONTAP Intercluster LIF IP addresses. One IP address per cluster node is required ,
Required: True ,
}
[
string ,
]
,
peerVserverName:
{
Description: External Vserver (SVM) name name of the SVM hosting the origin volume ,
Required: True ,
}
string ,
peerVolumeName:
{
Description: External origin volume name associated to this cache ,
Required: True ,
}
string ,
}
,
cifsChangeNotifications:
{
Description: Flag indicating whether a CIFS change notification is enabled for the cache. ,
Enum:
{
Disabled: CIFS change notification is disabled ,
Enabled: CIFS change notification is enabled ,
}
,
Required: False ,
}
enum ,
globalFileLocking:
{
Description: Flag indicating whether the global file lock is enabled for the cache. ,
Enum:
{
Disabled: Global file locking is disabled ,
Enabled: Global file locking is enabled ,
}
,
Required: False ,
}
enum ,
writeBack:
{
Description: Flag indicating whether writeback is enabled for the cache. ,
Enum:
{
Disabled: Writeback cache is disabled ,
Enabled: Writeback cache is enabled ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
zones:
{
Description: The availability zones. ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Caches_CreateOrUpdate (updated)
Description :  Create or update the specified Cache within the Capacity Pool
Reference :  Link ¶

⚶ Changes

{
  "#id": "Caches_CreateOrUpdate",
  "$parameters": {
    "body": {
      "$properties": {
        "properties": [
          {
            "#name": "exportPolicy",
            "Type": {
              "new": "object",
              "old": "array"
            }
          },
          {
            "#name": "protocolTypes",
            "Description": {
              "new": "Set of supported protocol types, which include NFSv3, NFSv4 and SMB protocol",
              "old": "Set of protocol types, default NFSv3, CIFS for SMB protocol"
            },
            "$items": {
              "Description": {
                "new": "Set of supported protocol types, which include NFSv3, NFSv4 and SMB protocol",
                "old": "Export policy rule"
              }
            }
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "exportPolicy",
            "Type": {
              "new": "object",
              "old": "array"
            }
          },
          {
            "#name": "protocolTypes",
            "Description": {
              "new": "Set of supported protocol types, which include NFSv3, NFSv4 and SMB protocol",
              "old": "Set of protocol types, default NFSv3, CIFS for SMB protocol"
            },
            "$items": {
              "Description": {
                "new": "Set of supported protocol types, which include NFSv3, NFSv4 and SMB protocol",
                "old": "Export policy rule"
              }
            }
          }
        ]
      }
    },
    "201": {
      "$properties": {
        "properties": [
          {
            "#name": "exportPolicy",
            "Type": {
              "new": "object",
              "old": "array"
            }
          },
          {
            "#name": "protocolTypes",
            "Description": {
              "new": "Set of supported protocol types, which include NFSv3, NFSv4 and SMB protocol",
              "old": "Set of protocol types, default NFSv3, CIFS for SMB protocol"
            },
            "$items": {
              "Description": {
                "new": "Set of supported protocol types, which include NFSv3, NFSv4 and SMB protocol",
                "old": "Export policy rule"
              }
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/caches/{cacheName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the NetApp account ,
Required: True ,
}
string ,
poolName:
{
Description: The name of the capacity pool ,
Required: True ,
}
string ,
cacheName:
{
Description: The name of the cache resource. ,
Required: True ,
}
string ,
body:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: Cache properties ,
Required: True ,
}
{
filepath:
{
Description: The file path of the Cache. ,
Required: True ,
}
string ,
size:
{
Description: Maximum storage quota allowed for a file system in bytes. Valid values are in the range 50GiB to 1PiB. Values expressed in bytes as multiples of 1GiB. ,
Format: int64 ,
Required: True ,
}
integer ,
exportPolicy:
{
Description: Set of export policy rules ,
Required: False ,
}
{
rules:
{
Description: Export policy rule ,
Required: False ,
}
[
{
ruleIndex:
{
Description: Order index ,
Format: int32 ,
Required: False ,
}
integer ,
unixReadOnly:
{
Description: Read only access ,
Required: False ,
}
boolean ,
unixReadWrite:
{
Description: Read and write access ,
Required: False ,
}
boolean ,
kerberos5ReadOnly:
{
Description: Kerberos5 Read only access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5ReadWrite:
{
Description: Kerberos5 Read and write access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5iReadOnly:
{
Description: Kerberos5i Read only access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5iReadWrite:
{
Description: Kerberos5i Read and write access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5pReadOnly:
{
Description: Kerberos5p Read only access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5pReadWrite:
{
Description: Kerberos5p Read and write access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
cifs:
{
Description: Allows CIFS protocol ,
Required: False ,
}
boolean ,
nfsv3:
{
Description: Allows NFSv3 protocol. Enable only for NFSv3 type volumes ,
Required: False ,
}
boolean ,
nfsv41:
{
Description: Allows NFSv4.1 protocol. Enable only for NFSv4.1 type volumes ,
Required: False ,
}
boolean ,
allowedClients:
{
Description: Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names ,
Required: False ,
}
string ,
hasRootAccess:
{
Description: Has root access to volume ,
Required: False ,
}
boolean ,
chownMode:
{
Description: This parameter specifies who is authorized to change the ownership of a file. restricted - Only root user can change the ownership of the file. unrestricted - Non-root users can change ownership of files that they own. ,
Enum:
{
Restricted: No description available. ,
Unrestricted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
protocolTypes:
{
Description: Set of supported protocol types, which include NFSv3, NFSv4 and SMB protocol ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: Azure lifecycle management ,
Enum:
{
Creating: The resource is being created. ,
Updating: The resource is being updated. ,
Deleting: The resource is being deleted. ,
Failed: The resource is in a failed state. ,
Succeeded: The resource is succeeded. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
cacheState:
{
Description: Azure NetApp Files Cache lifecycle management ,
Enum:
{
ClusterPeeringOfferSent: Cluster peering offer has been sent. ,
VserverPeeringOfferSent: VServer peering offer has been sent. ,
Creating: Cache creation in progress. ,
Succeeded: Cache creation succeeded and is available for use. ,
Failed: Cache is in a failed state ,
}
,
Required: False ,
}
enum ,
cacheSubnetResourceId:
{
Description: The Azure Resource URI for a delegated cache subnet that will be used to allocate data IPs. ,
Format: arm-id ,
Required: True ,
}
string ,
peeringSubnetResourceId:
{
Description: The Azure Resource URI for a delegated subnet that will be used for ANF Intercluster Interface IP addresses. ,
Format: arm-id ,
Required: True ,
}
string ,
mountTargets:
{
Description: List of mount targets that can be used to mount this cache ,
Required: False ,
}
[
{
mountTargetId:
{
Description: UUID v4 used to identify the MountTarget ,
Required: False ,
}
string ,
ipAddress:
{
Description: The mount target's IPv4 address, used to mount the cache. ,
Required: False ,
}
string ,
smbServerFqdn:
{
Description: The SMB server's Fully Qualified Domain Name, FQDN ,
Required: False ,
}
string ,
}
,
]
,
kerberos:
{
Description: Describe if a cache is Kerberos enabled. ,
Enum:
{
Disabled: Kerberos is disabled ,
Enabled: Kerberos is enabled ,
}
,
Required: False ,
}
enum ,
smbSettings:
{
Description: SMB information for the cache ,
Required: False ,
}
{
smbEncryption:
{
Description: Enables encryption for in-flight smb3 data. Only applicable for SMB/DualProtocol cache. ,
Enum:
{
Disabled: SMB encryption is disabled ,
Enabled: SMB encryption is enabled ,
}
,
Required: False ,
}
enum ,
smbAccessBasedEnumerations:
{
Description: Enables access-based enumeration share property for SMB Shares. Only applicable for SMB/DualProtocol volume ,
Enum:
{
Disabled: smbAccessBasedEnumeration share setting is disabled ,
Enabled: smbAccessBasedEnumeration share setting is enabled ,
}
,
Required: False ,
}
enum ,
smbNonBrowsable:
{
Description: Enables non-browsable property for SMB Shares. Only applicable for SMB/DualProtocol volume ,
Enum:
{
Disabled: smbNonBrowsable share setting is disabled ,
Enabled: smbNonBrowsable share setting is enabled ,
}
,
Required: False ,
}
enum ,
}
,
throughputMibps:
{
Description: Maximum throughput in MiB/s that can be achieved by this cache volume and this will be accepted as input only for manual qosType cache ,
Format: float ,
Required: False ,
}
number ,
actualThroughputMibps:
{
Description: Actual throughput in MiB/s for auto qosType volumes calculated based on size and serviceLevel ,
Format: float ,
Required: False ,
}
number ,
encryptionKeySource:
{
Description: Source of key used to encrypt data in the cache. Applicable if NetApp account has encryption.keySource = 'Microsoft.KeyVault'. Possible values (case-insensitive) are: 'Microsoft.NetApp, Microsoft.KeyVault' ,
Enum:
{
Microsoft.NetApp: Microsoft-managed key encryption ,
Microsoft.KeyVault: Customer-managed key encryption ,
}
,
Required: True ,
}
enum ,
keyVaultPrivateEndpointResourceId:
{
Description: The resource ID of private endpoint for KeyVault. It must reside in the same VNET as the volume. Only applicable if encryptionKeySource = 'Microsoft.KeyVault'. ,
Format: arm-id ,
Required: False ,
}
string ,
maximumNumberOfFiles:
{
Description: Maximum number of files allowed. ,
Format: int64 ,
Required: False ,
}
integer ,
encryption:
{
Description: Specifies if the cache is encryption or not. ,
Enum:
{
Disabled: Encryption is disabled ,
Enabled: Encryption is enabled ,
}
,
Required: False ,
}
enum ,
language:
{
Description: Language supported for volume. ,
Enum:
{
c.utf-8: Posix with UTF-8 ,
utf8mb4: UTF-8 with 4 byte character support ,
ar: Arabic - Deprecated ,
ar.utf-8: Arabic with UTF-8 ,
hr: Croatian - Deprecated ,
hr.utf-8: Croatian with UTF-8 ,
cs: Czech - Deprecated ,
cs.utf-8: Czech with UTF-8 ,
da: Danish - Deprecated ,
da.utf-8: Danish with UTF-8 ,
nl: Dutch - Deprecated ,
nl.utf-8: Dutch with UTF-8 ,
en: English - Deprecated ,
en.utf-8: English with UTF-8 ,
fi: Finnish - Deprecated ,
fi.utf-8: Finnish with UTF-8 ,
fr: French - Deprecated ,
fr.utf-8: French with UTF-8 ,
de: German - Deprecated ,
de.utf-8: German with UTF-8 ,
he: Hebrew - Deprecated ,
he.utf-8: Hebrew with UTF-8 ,
hu: Hungarian - Deprecated ,
hu.utf-8: Hungarian with UTF-8 ,
it: Italian - Deprecated ,
it.utf-8: Italian with UTF-8 ,
ja: Japanese euc-j - Deprecated ,
ja.utf-8: Japanese euc-j with UTF-8 ,
ja-v1: Japanese euc-j - Deprecated ,
ja-v1.utf-8: Japanese euc-j with UTF-8 ,
ja-jp.pck: Japanese pck ,
ja-jp.pck.utf-8: Japanese pck with UTF-8 - Deprecated ,
ja-jp.932: Japanese cp932 ,
ja-jp.932.utf-8: Japanese cp932 with UTF-8 - Deprecated ,
ja-jp.pck-v2: Japanese pck - sjis ,
ja-jp.pck-v2.utf-8: Japanese pck - sjis with UTF-8 - Deprecated ,
ko: Korean - Deprecated ,
ko.utf-8: Korean with UTF-8 ,
no: Norwegian - Deprecated ,
no.utf-8: Norwegian with UTF-8 ,
pl: Polish - Deprecated ,
pl.utf-8: Polish with UTF-8 ,
pt: Portuguese - Deprecated ,
pt.utf-8: Portuguese with UTF-8 ,
c: Posix - Deprecated ,
ro: Romanian - Deprecated ,
ro.utf-8: Romanian with UTF-8 ,
ru: Russian - Deprecated ,
ru.utf-8: Russian with UTF-8 ,
zh: Simplified Chinese - Deprecated ,
zh.utf-8: Simplified Chinese with UTF-8 ,
zh.gbk: Simplified gbk Chinese ,
zh.gbk.utf-8: Simplified gbk Chinese with UTF-8 - Deprecated ,
zh-tw.big5: Traditional Chinese BIG 5 ,
zh-tw.big5.utf-8: Traditional Chinese BIG 5 with UTF-8 - Deprecated ,
zh-tw: Traditional Chinese EUC-TW ,
zh-tw.utf-8: Traditional Chinese EUC-TW with UTF-8 - Deprecated ,
sk: Slovak - Deprecated ,
sk.utf-8: Slovak with UTF-8 ,
sl: Slovenian - Deprecated ,
sl.utf-8: Slovenian with UTF-8 ,
es: Spanish - Deprecated ,
es.utf-8: Spanish with UTF-8 ,
sv: Swedish - Deprecated ,
sv.utf-8: Swedish with UTF-8 ,
tr: Turkish - Deprecated ,
tr.utf-8: Turkish with UTF-8 ,
en-us: US English - Deprecated ,
en-us.utf-8: US English with UTF-8 ,
}
,
Required: False ,
}
enum ,
ldap:
{
Description: Specifies whether LDAP is enabled or not for flexcache volume. ,
Enum:
{
Disabled: ldap is disabled. ,
Enabled: ldap is enabled ,
}
,
Required: False ,
}
enum ,
ldapServerType:
{
Description: Specifies the type of LDAP server for flexcache volume. ,
Enum:
{
ActiveDirectory: The volume should use Active Directory for LDAP connections. ,
OpenLDAP: The volume should use OpenLDAP for LDAP connections. ,
}
,
Required: False ,
}
enum ,
originClusterInformation:
{
Description: Origin cluster information ,
Required: True ,
}
{
peerClusterName:
{
Description: ONTAP cluster name of external cluster hosting the origin volume ,
Required: True ,
}
string ,
peerAddresses:
{
Description: ONTAP Intercluster LIF IP addresses. One IP address per cluster node is required ,
Required: True ,
}
[
string ,
]
,
peerVserverName:
{
Description: External Vserver (SVM) name name of the SVM hosting the origin volume ,
Required: True ,
}
string ,
peerVolumeName:
{
Description: External origin volume name associated to this cache ,
Required: True ,
}
string ,
}
,
cifsChangeNotifications:
{
Description: Flag indicating whether a CIFS change notification is enabled for the cache. ,
Enum:
{
Disabled: CIFS change notification is disabled ,
Enabled: CIFS change notification is enabled ,
}
,
Required: False ,
}
enum ,
globalFileLocking:
{
Description: Flag indicating whether the global file lock is enabled for the cache. ,
Enum:
{
Disabled: Global file locking is disabled ,
Enabled: Global file locking is enabled ,
}
,
Required: False ,
}
enum ,
writeBack:
{
Description: Flag indicating whether writeback is enabled for the cache. ,
Enum:
{
Disabled: Writeback cache is disabled ,
Enabled: Writeback cache is enabled ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
zones:
{
Description: The availability zones. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Cache properties ,
Required: True ,
}
{
filepath:
{
Description: The file path of the Cache. ,
Required: True ,
}
string ,
size:
{
Description: Maximum storage quota allowed for a file system in bytes. Valid values are in the range 50GiB to 1PiB. Values expressed in bytes as multiples of 1GiB. ,
Format: int64 ,
Required: True ,
}
integer ,
exportPolicy:
{
Description: Set of export policy rules ,
Required: False ,
}
{
rules:
{
Description: Export policy rule ,
Required: False ,
}
[
{
ruleIndex:
{
Description: Order index ,
Format: int32 ,
Required: False ,
}
integer ,
unixReadOnly:
{
Description: Read only access ,
Required: False ,
}
boolean ,
unixReadWrite:
{
Description: Read and write access ,
Required: False ,
}
boolean ,
kerberos5ReadOnly:
{
Description: Kerberos5 Read only access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5ReadWrite:
{
Description: Kerberos5 Read and write access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5iReadOnly:
{
Description: Kerberos5i Read only access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5iReadWrite:
{
Description: Kerberos5i Read and write access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5pReadOnly:
{
Description: Kerberos5p Read only access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5pReadWrite:
{
Description: Kerberos5p Read and write access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
cifs:
{
Description: Allows CIFS protocol ,
Required: False ,
}
boolean ,
nfsv3:
{
Description: Allows NFSv3 protocol. Enable only for NFSv3 type volumes ,
Required: False ,
}
boolean ,
nfsv41:
{
Description: Allows NFSv4.1 protocol. Enable only for NFSv4.1 type volumes ,
Required: False ,
}
boolean ,
allowedClients:
{
Description: Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names ,
Required: False ,
}
string ,
hasRootAccess:
{
Description: Has root access to volume ,
Required: False ,
}
boolean ,
chownMode:
{
Description: This parameter specifies who is authorized to change the ownership of a file. restricted - Only root user can change the ownership of the file. unrestricted - Non-root users can change ownership of files that they own. ,
Enum:
{
Restricted: No description available. ,
Unrestricted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
protocolTypes:
{
Description: Set of supported protocol types, which include NFSv3, NFSv4 and SMB protocol ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: Azure lifecycle management ,
Enum:
{
Creating: The resource is being created. ,
Updating: The resource is being updated. ,
Deleting: The resource is being deleted. ,
Failed: The resource is in a failed state. ,
Succeeded: The resource is succeeded. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
cacheState:
{
Description: Azure NetApp Files Cache lifecycle management ,
Enum:
{
ClusterPeeringOfferSent: Cluster peering offer has been sent. ,
VserverPeeringOfferSent: VServer peering offer has been sent. ,
Creating: Cache creation in progress. ,
Succeeded: Cache creation succeeded and is available for use. ,
Failed: Cache is in a failed state ,
}
,
Required: False ,
}
enum ,
cacheSubnetResourceId:
{
Description: The Azure Resource URI for a delegated cache subnet that will be used to allocate data IPs. ,
Format: arm-id ,
Required: True ,
}
string ,
peeringSubnetResourceId:
{
Description: The Azure Resource URI for a delegated subnet that will be used for ANF Intercluster Interface IP addresses. ,
Format: arm-id ,
Required: True ,
}
string ,
mountTargets:
{
Description: List of mount targets that can be used to mount this cache ,
Required: False ,
}
[
{
mountTargetId:
{
Description: UUID v4 used to identify the MountTarget ,
Required: False ,
}
string ,
ipAddress:
{
Description: The mount target's IPv4 address, used to mount the cache. ,
Required: False ,
}
string ,
smbServerFqdn:
{
Description: The SMB server's Fully Qualified Domain Name, FQDN ,
Required: False ,
}
string ,
}
,
]
,
kerberos:
{
Description: Describe if a cache is Kerberos enabled. ,
Enum:
{
Disabled: Kerberos is disabled ,
Enabled: Kerberos is enabled ,
}
,
Required: False ,
}
enum ,
smbSettings:
{
Description: SMB information for the cache ,
Required: False ,
}
{
smbEncryption:
{
Description: Enables encryption for in-flight smb3 data. Only applicable for SMB/DualProtocol cache. ,
Enum:
{
Disabled: SMB encryption is disabled ,
Enabled: SMB encryption is enabled ,
}
,
Required: False ,
}
enum ,
smbAccessBasedEnumerations:
{
Description: Enables access-based enumeration share property for SMB Shares. Only applicable for SMB/DualProtocol volume ,
Enum:
{
Disabled: smbAccessBasedEnumeration share setting is disabled ,
Enabled: smbAccessBasedEnumeration share setting is enabled ,
}
,
Required: False ,
}
enum ,
smbNonBrowsable:
{
Description: Enables non-browsable property for SMB Shares. Only applicable for SMB/DualProtocol volume ,
Enum:
{
Disabled: smbNonBrowsable share setting is disabled ,
Enabled: smbNonBrowsable share setting is enabled ,
}
,
Required: False ,
}
enum ,
}
,
throughputMibps:
{
Description: Maximum throughput in MiB/s that can be achieved by this cache volume and this will be accepted as input only for manual qosType cache ,
Format: float ,
Required: False ,
}
number ,
actualThroughputMibps:
{
Description: Actual throughput in MiB/s for auto qosType volumes calculated based on size and serviceLevel ,
Format: float ,
Required: False ,
}
number ,
encryptionKeySource:
{
Description: Source of key used to encrypt data in the cache. Applicable if NetApp account has encryption.keySource = 'Microsoft.KeyVault'. Possible values (case-insensitive) are: 'Microsoft.NetApp, Microsoft.KeyVault' ,
Enum:
{
Microsoft.NetApp: Microsoft-managed key encryption ,
Microsoft.KeyVault: Customer-managed key encryption ,
}
,
Required: True ,
}
enum ,
keyVaultPrivateEndpointResourceId:
{
Description: The resource ID of private endpoint for KeyVault. It must reside in the same VNET as the volume. Only applicable if encryptionKeySource = 'Microsoft.KeyVault'. ,
Format: arm-id ,
Required: False ,
}
string ,
maximumNumberOfFiles:
{
Description: Maximum number of files allowed. ,
Format: int64 ,
Required: False ,
}
integer ,
encryption:
{
Description: Specifies if the cache is encryption or not. ,
Enum:
{
Disabled: Encryption is disabled ,
Enabled: Encryption is enabled ,
}
,
Required: False ,
}
enum ,
language:
{
Description: Language supported for volume. ,
Enum:
{
c.utf-8: Posix with UTF-8 ,
utf8mb4: UTF-8 with 4 byte character support ,
ar: Arabic - Deprecated ,
ar.utf-8: Arabic with UTF-8 ,
hr: Croatian - Deprecated ,
hr.utf-8: Croatian with UTF-8 ,
cs: Czech - Deprecated ,
cs.utf-8: Czech with UTF-8 ,
da: Danish - Deprecated ,
da.utf-8: Danish with UTF-8 ,
nl: Dutch - Deprecated ,
nl.utf-8: Dutch with UTF-8 ,
en: English - Deprecated ,
en.utf-8: English with UTF-8 ,
fi: Finnish - Deprecated ,
fi.utf-8: Finnish with UTF-8 ,
fr: French - Deprecated ,
fr.utf-8: French with UTF-8 ,
de: German - Deprecated ,
de.utf-8: German with UTF-8 ,
he: Hebrew - Deprecated ,
he.utf-8: Hebrew with UTF-8 ,
hu: Hungarian - Deprecated ,
hu.utf-8: Hungarian with UTF-8 ,
it: Italian - Deprecated ,
it.utf-8: Italian with UTF-8 ,
ja: Japanese euc-j - Deprecated ,
ja.utf-8: Japanese euc-j with UTF-8 ,
ja-v1: Japanese euc-j - Deprecated ,
ja-v1.utf-8: Japanese euc-j with UTF-8 ,
ja-jp.pck: Japanese pck ,
ja-jp.pck.utf-8: Japanese pck with UTF-8 - Deprecated ,
ja-jp.932: Japanese cp932 ,
ja-jp.932.utf-8: Japanese cp932 with UTF-8 - Deprecated ,
ja-jp.pck-v2: Japanese pck - sjis ,
ja-jp.pck-v2.utf-8: Japanese pck - sjis with UTF-8 - Deprecated ,
ko: Korean - Deprecated ,
ko.utf-8: Korean with UTF-8 ,
no: Norwegian - Deprecated ,
no.utf-8: Norwegian with UTF-8 ,
pl: Polish - Deprecated ,
pl.utf-8: Polish with UTF-8 ,
pt: Portuguese - Deprecated ,
pt.utf-8: Portuguese with UTF-8 ,
c: Posix - Deprecated ,
ro: Romanian - Deprecated ,
ro.utf-8: Romanian with UTF-8 ,
ru: Russian - Deprecated ,
ru.utf-8: Russian with UTF-8 ,
zh: Simplified Chinese - Deprecated ,
zh.utf-8: Simplified Chinese with UTF-8 ,
zh.gbk: Simplified gbk Chinese ,
zh.gbk.utf-8: Simplified gbk Chinese with UTF-8 - Deprecated ,
zh-tw.big5: Traditional Chinese BIG 5 ,
zh-tw.big5.utf-8: Traditional Chinese BIG 5 with UTF-8 - Deprecated ,
zh-tw: Traditional Chinese EUC-TW ,
zh-tw.utf-8: Traditional Chinese EUC-TW with UTF-8 - Deprecated ,
sk: Slovak - Deprecated ,
sk.utf-8: Slovak with UTF-8 ,
sl: Slovenian - Deprecated ,
sl.utf-8: Slovenian with UTF-8 ,
es: Spanish - Deprecated ,
es.utf-8: Spanish with UTF-8 ,
sv: Swedish - Deprecated ,
sv.utf-8: Swedish with UTF-8 ,
tr: Turkish - Deprecated ,
tr.utf-8: Turkish with UTF-8 ,
en-us: US English - Deprecated ,
en-us.utf-8: US English with UTF-8 ,
}
,
Required: False ,
}
enum ,
ldap:
{
Description: Specifies whether LDAP is enabled or not for flexcache volume. ,
Enum:
{
Disabled: ldap is disabled. ,
Enabled: ldap is enabled ,
}
,
Required: False ,
}
enum ,
ldapServerType:
{
Description: Specifies the type of LDAP server for flexcache volume. ,
Enum:
{
ActiveDirectory: The volume should use Active Directory for LDAP connections. ,
OpenLDAP: The volume should use OpenLDAP for LDAP connections. ,
}
,
Required: False ,
}
enum ,
originClusterInformation:
{
Description: Origin cluster information ,
Required: True ,
}
{
peerClusterName:
{
Description: ONTAP cluster name of external cluster hosting the origin volume ,
Required: True ,
}
string ,
peerAddresses:
{
Description: ONTAP Intercluster LIF IP addresses. One IP address per cluster node is required ,
Required: True ,
}
[
string ,
]
,
peerVserverName:
{
Description: External Vserver (SVM) name name of the SVM hosting the origin volume ,
Required: True ,
}
string ,
peerVolumeName:
{
Description: External origin volume name associated to this cache ,
Required: True ,
}
string ,
}
,
cifsChangeNotifications:
{
Description: Flag indicating whether a CIFS change notification is enabled for the cache. ,
Enum:
{
Disabled: CIFS change notification is disabled ,
Enabled: CIFS change notification is enabled ,
}
,
Required: False ,
}
enum ,
globalFileLocking:
{
Description: Flag indicating whether the global file lock is enabled for the cache. ,
Enum:
{
Disabled: Global file locking is disabled ,
Enabled: Global file locking is enabled ,
}
,
Required: False ,
}
enum ,
writeBack:
{
Description: Flag indicating whether writeback is enabled for the cache. ,
Enum:
{
Disabled: Writeback cache is disabled ,
Enabled: Writeback cache is enabled ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
zones:
{
Description: The availability zones. ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Cache resource ,
}
{
properties:
{
Description: Cache properties ,
Required: True ,
}
{
filepath:
{
Description: The file path of the Cache. ,
Required: True ,
}
string ,
size:
{
Description: Maximum storage quota allowed for a file system in bytes. Valid values are in the range 50GiB to 1PiB. Values expressed in bytes as multiples of 1GiB. ,
Format: int64 ,
Required: True ,
}
integer ,
exportPolicy:
{
Description: Set of export policy rules ,
Required: False ,
}
{
rules:
{
Description: Export policy rule ,
Required: False ,
}
[
{
ruleIndex:
{
Description: Order index ,
Format: int32 ,
Required: False ,
}
integer ,
unixReadOnly:
{
Description: Read only access ,
Required: False ,
}
boolean ,
unixReadWrite:
{
Description: Read and write access ,
Required: False ,
}
boolean ,
kerberos5ReadOnly:
{
Description: Kerberos5 Read only access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5ReadWrite:
{
Description: Kerberos5 Read and write access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5iReadOnly:
{
Description: Kerberos5i Read only access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5iReadWrite:
{
Description: Kerberos5i Read and write access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5pReadOnly:
{
Description: Kerberos5p Read only access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5pReadWrite:
{
Description: Kerberos5p Read and write access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
cifs:
{
Description: Allows CIFS protocol ,
Required: False ,
}
boolean ,
nfsv3:
{
Description: Allows NFSv3 protocol. Enable only for NFSv3 type volumes ,
Required: False ,
}
boolean ,
nfsv41:
{
Description: Allows NFSv4.1 protocol. Enable only for NFSv4.1 type volumes ,
Required: False ,
}
boolean ,
allowedClients:
{
Description: Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names ,
Required: False ,
}
string ,
hasRootAccess:
{
Description: Has root access to volume ,
Required: False ,
}
boolean ,
chownMode:
{
Description: This parameter specifies who is authorized to change the ownership of a file. restricted - Only root user can change the ownership of the file. unrestricted - Non-root users can change ownership of files that they own. ,
Enum:
{
Restricted: No description available. ,
Unrestricted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
protocolTypes:
{
Description: Set of supported protocol types, which include NFSv3, NFSv4 and SMB protocol ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: Azure lifecycle management ,
Enum:
{
Creating: The resource is being created. ,
Updating: The resource is being updated. ,
Deleting: The resource is being deleted. ,
Failed: The resource is in a failed state. ,
Succeeded: The resource is succeeded. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
cacheState:
{
Description: Azure NetApp Files Cache lifecycle management ,
Enum:
{
ClusterPeeringOfferSent: Cluster peering offer has been sent. ,
VserverPeeringOfferSent: VServer peering offer has been sent. ,
Creating: Cache creation in progress. ,
Succeeded: Cache creation succeeded and is available for use. ,
Failed: Cache is in a failed state ,
}
,
Required: False ,
}
enum ,
cacheSubnetResourceId:
{
Description: The Azure Resource URI for a delegated cache subnet that will be used to allocate data IPs. ,
Format: arm-id ,
Required: True ,
}
string ,
peeringSubnetResourceId:
{
Description: The Azure Resource URI for a delegated subnet that will be used for ANF Intercluster Interface IP addresses. ,
Format: arm-id ,
Required: True ,
}
string ,
mountTargets:
{
Description: List of mount targets that can be used to mount this cache ,
Required: False ,
}
[
{
mountTargetId:
{
Description: UUID v4 used to identify the MountTarget ,
Required: False ,
}
string ,
ipAddress:
{
Description: The mount target's IPv4 address, used to mount the cache. ,
Required: False ,
}
string ,
smbServerFqdn:
{
Description: The SMB server's Fully Qualified Domain Name, FQDN ,
Required: False ,
}
string ,
}
,
]
,
kerberos:
{
Description: Describe if a cache is Kerberos enabled. ,
Enum:
{
Disabled: Kerberos is disabled ,
Enabled: Kerberos is enabled ,
}
,
Required: False ,
}
enum ,
smbSettings:
{
Description: SMB information for the cache ,
Required: False ,
}
{
smbEncryption:
{
Description: Enables encryption for in-flight smb3 data. Only applicable for SMB/DualProtocol cache. ,
Enum:
{
Disabled: SMB encryption is disabled ,
Enabled: SMB encryption is enabled ,
}
,
Required: False ,
}
enum ,
smbAccessBasedEnumerations:
{
Description: Enables access-based enumeration share property for SMB Shares. Only applicable for SMB/DualProtocol volume ,
Enum:
{
Disabled: smbAccessBasedEnumeration share setting is disabled ,
Enabled: smbAccessBasedEnumeration share setting is enabled ,
}
,
Required: False ,
}
enum ,
smbNonBrowsable:
{
Description: Enables non-browsable property for SMB Shares. Only applicable for SMB/DualProtocol volume ,
Enum:
{
Disabled: smbNonBrowsable share setting is disabled ,
Enabled: smbNonBrowsable share setting is enabled ,
}
,
Required: False ,
}
enum ,
}
,
throughputMibps:
{
Description: Maximum throughput in MiB/s that can be achieved by this cache volume and this will be accepted as input only for manual qosType cache ,
Format: float ,
Required: False ,
}
number ,
actualThroughputMibps:
{
Description: Actual throughput in MiB/s for auto qosType volumes calculated based on size and serviceLevel ,
Format: float ,
Required: False ,
}
number ,
encryptionKeySource:
{
Description: Source of key used to encrypt data in the cache. Applicable if NetApp account has encryption.keySource = 'Microsoft.KeyVault'. Possible values (case-insensitive) are: 'Microsoft.NetApp, Microsoft.KeyVault' ,
Enum:
{
Microsoft.NetApp: Microsoft-managed key encryption ,
Microsoft.KeyVault: Customer-managed key encryption ,
}
,
Required: True ,
}
enum ,
keyVaultPrivateEndpointResourceId:
{
Description: The resource ID of private endpoint for KeyVault. It must reside in the same VNET as the volume. Only applicable if encryptionKeySource = 'Microsoft.KeyVault'. ,
Format: arm-id ,
Required: False ,
}
string ,
maximumNumberOfFiles:
{
Description: Maximum number of files allowed. ,
Format: int64 ,
Required: False ,
}
integer ,
encryption:
{
Description: Specifies if the cache is encryption or not. ,
Enum:
{
Disabled: Encryption is disabled ,
Enabled: Encryption is enabled ,
}
,
Required: False ,
}
enum ,
language:
{
Description: Language supported for volume. ,
Enum:
{
c.utf-8: Posix with UTF-8 ,
utf8mb4: UTF-8 with 4 byte character support ,
ar: Arabic - Deprecated ,
ar.utf-8: Arabic with UTF-8 ,
hr: Croatian - Deprecated ,
hr.utf-8: Croatian with UTF-8 ,
cs: Czech - Deprecated ,
cs.utf-8: Czech with UTF-8 ,
da: Danish - Deprecated ,
da.utf-8: Danish with UTF-8 ,
nl: Dutch - Deprecated ,
nl.utf-8: Dutch with UTF-8 ,
en: English - Deprecated ,
en.utf-8: English with UTF-8 ,
fi: Finnish - Deprecated ,
fi.utf-8: Finnish with UTF-8 ,
fr: French - Deprecated ,
fr.utf-8: French with UTF-8 ,
de: German - Deprecated ,
de.utf-8: German with UTF-8 ,
he: Hebrew - Deprecated ,
he.utf-8: Hebrew with UTF-8 ,
hu: Hungarian - Deprecated ,
hu.utf-8: Hungarian with UTF-8 ,
it: Italian - Deprecated ,
it.utf-8: Italian with UTF-8 ,
ja: Japanese euc-j - Deprecated ,
ja.utf-8: Japanese euc-j with UTF-8 ,
ja-v1: Japanese euc-j - Deprecated ,
ja-v1.utf-8: Japanese euc-j with UTF-8 ,
ja-jp.pck: Japanese pck ,
ja-jp.pck.utf-8: Japanese pck with UTF-8 - Deprecated ,
ja-jp.932: Japanese cp932 ,
ja-jp.932.utf-8: Japanese cp932 with UTF-8 - Deprecated ,
ja-jp.pck-v2: Japanese pck - sjis ,
ja-jp.pck-v2.utf-8: Japanese pck - sjis with UTF-8 - Deprecated ,
ko: Korean - Deprecated ,
ko.utf-8: Korean with UTF-8 ,
no: Norwegian - Deprecated ,
no.utf-8: Norwegian with UTF-8 ,
pl: Polish - Deprecated ,
pl.utf-8: Polish with UTF-8 ,
pt: Portuguese - Deprecated ,
pt.utf-8: Portuguese with UTF-8 ,
c: Posix - Deprecated ,
ro: Romanian - Deprecated ,
ro.utf-8: Romanian with UTF-8 ,
ru: Russian - Deprecated ,
ru.utf-8: Russian with UTF-8 ,
zh: Simplified Chinese - Deprecated ,
zh.utf-8: Simplified Chinese with UTF-8 ,
zh.gbk: Simplified gbk Chinese ,
zh.gbk.utf-8: Simplified gbk Chinese with UTF-8 - Deprecated ,
zh-tw.big5: Traditional Chinese BIG 5 ,
zh-tw.big5.utf-8: Traditional Chinese BIG 5 with UTF-8 - Deprecated ,
zh-tw: Traditional Chinese EUC-TW ,
zh-tw.utf-8: Traditional Chinese EUC-TW with UTF-8 - Deprecated ,
sk: Slovak - Deprecated ,
sk.utf-8: Slovak with UTF-8 ,
sl: Slovenian - Deprecated ,
sl.utf-8: Slovenian with UTF-8 ,
es: Spanish - Deprecated ,
es.utf-8: Spanish with UTF-8 ,
sv: Swedish - Deprecated ,
sv.utf-8: Swedish with UTF-8 ,
tr: Turkish - Deprecated ,
tr.utf-8: Turkish with UTF-8 ,
en-us: US English - Deprecated ,
en-us.utf-8: US English with UTF-8 ,
}
,
Required: False ,
}
enum ,
ldap:
{
Description: Specifies whether LDAP is enabled or not for flexcache volume. ,
Enum:
{
Disabled: ldap is disabled. ,
Enabled: ldap is enabled ,
}
,
Required: False ,
}
enum ,
ldapServerType:
{
Description: Specifies the type of LDAP server for flexcache volume. ,
Enum:
{
ActiveDirectory: The volume should use Active Directory for LDAP connections. ,
OpenLDAP: The volume should use OpenLDAP for LDAP connections. ,
}
,
Required: False ,
}
enum ,
originClusterInformation:
{
Description: Origin cluster information ,
Required: True ,
}
{
peerClusterName:
{
Description: ONTAP cluster name of external cluster hosting the origin volume ,
Required: True ,
}
string ,
peerAddresses:
{
Description: ONTAP Intercluster LIF IP addresses. One IP address per cluster node is required ,
Required: True ,
}
[
string ,
]
,
peerVserverName:
{
Description: External Vserver (SVM) name name of the SVM hosting the origin volume ,
Required: True ,
}
string ,
peerVolumeName:
{
Description: External origin volume name associated to this cache ,
Required: True ,
}
string ,
}
,
cifsChangeNotifications:
{
Description: Flag indicating whether a CIFS change notification is enabled for the cache. ,
Enum:
{
Disabled: CIFS change notification is disabled ,
Enabled: CIFS change notification is enabled ,
}
,
Required: False ,
}
enum ,
globalFileLocking:
{
Description: Flag indicating whether the global file lock is enabled for the cache. ,
Enum:
{
Disabled: Global file locking is disabled ,
Enabled: Global file locking is enabled ,
}
,
Required: False ,
}
enum ,
writeBack:
{
Description: Flag indicating whether writeback is enabled for the cache. ,
Enum:
{
Disabled: Writeback cache is disabled ,
Enabled: Writeback cache is enabled ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
zones:
{
Description: The availability zones. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Caches_Update (updated)
Description :  Patch the specified Cache
Reference :  Link ¶

⚶ Changes

{
  "#id": "Caches_Update",
  "$parameters": {
    "body": {
      "$properties": {
        "properties": [
          {
            "#name": "exportPolicy",
            "Type": {
              "new": "object",
              "old": "array"
            }
          },
          {
            "#name": "protocolTypes",
            "Description": {
              "new": "Set of supported protocol types, which include NFSv3, NFSv4 and SMB protocol",
              "old": "Set of protocol types, default NFSv3, CIFS for SMB protocol"
            },
            "$items": {
              "Description": {
                "new": "Set of supported protocol types, which include NFSv3, NFSv4 and SMB protocol",
                "old": "Export policy rule"
              }
            }
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "exportPolicy",
            "Type": {
              "new": "object",
              "old": "array"
            }
          },
          {
            "#name": "protocolTypes",
            "Description": {
              "new": "Set of supported protocol types, which include NFSv3, NFSv4 and SMB protocol",
              "old": "Set of protocol types, default NFSv3, CIFS for SMB protocol"
            },
            "$items": {
              "Description": {
                "new": "Set of supported protocol types, which include NFSv3, NFSv4 and SMB protocol",
                "old": "Export policy rule"
              }
            }
          }
        ]
      }
    },
    "202": [
      {
        "@added_8850c581783f4869a058c8e29edb9418": {
          "#name": "azure-asyncoperation",
          "Description": "A link to the status monitor",
          "Type": "string"
        }
      }
    ]
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/caches/{cacheName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the NetApp account ,
Required: True ,
}
string ,
poolName:
{
Description: The name of the capacity pool ,
Required: True ,
}
string ,
cacheName:
{
Description: The name of the cache resource. ,
Required: True ,
}
string ,
body:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
size:
{
Description: Maximum storage quota allowed for a file system in bytes. Valid values are in the range 50GiB to 1PiB. Values expressed in bytes as multiples of 1GiB. ,
Format: int64 ,
Required: False ,
}
integer ,
exportPolicy:
{
Description: Set of export policy rules ,
Required: False ,
}
{
rules:
{
Description: Export policy rule ,
Required: False ,
}
[
{
ruleIndex:
{
Description: Order index ,
Format: int32 ,
Required: False ,
}
integer ,
unixReadOnly:
{
Description: Read only access ,
Required: False ,
}
boolean ,
unixReadWrite:
{
Description: Read and write access ,
Required: False ,
}
boolean ,
kerberos5ReadOnly:
{
Description: Kerberos5 Read only access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5ReadWrite:
{
Description: Kerberos5 Read and write access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5iReadOnly:
{
Description: Kerberos5i Read only access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5iReadWrite:
{
Description: Kerberos5i Read and write access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5pReadOnly:
{
Description: Kerberos5p Read only access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5pReadWrite:
{
Description: Kerberos5p Read and write access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
cifs:
{
Description: Allows CIFS protocol ,
Required: False ,
}
boolean ,
nfsv3:
{
Description: Allows NFSv3 protocol. Enable only for NFSv3 type volumes ,
Required: False ,
}
boolean ,
nfsv41:
{
Description: Allows NFSv4.1 protocol. Enable only for NFSv4.1 type volumes ,
Required: False ,
}
boolean ,
allowedClients:
{
Description: Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names ,
Required: False ,
}
string ,
hasRootAccess:
{
Description: Has root access to volume ,
Required: False ,
}
boolean ,
chownMode:
{
Description: This parameter specifies who is authorized to change the ownership of a file. restricted - Only root user can change the ownership of the file. unrestricted - Non-root users can change ownership of files that they own. ,
Enum:
{
Restricted: No description available. ,
Unrestricted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
protocolTypes:
{
Description: Set of supported protocol types, which include NFSv3, NFSv4 and SMB protocol ,
Required: False ,
}
[
string ,
]
,
smbSettings:
{
Description: SMB information for the cache ,
Required: False ,
}
{
smbEncryption:
{
Description: Enables encryption for in-flight smb3 data. Only applicable for SMB/DualProtocol cache. ,
Enum:
{
Disabled: SMB encryption is disabled ,
Enabled: SMB encryption is enabled ,
}
,
Required: False ,
}
enum ,
smbAccessBasedEnumerations:
{
Description: Enables access-based enumeration share property for SMB Shares. Only applicable for SMB/DualProtocol volume ,
Enum:
{
Disabled: smbAccessBasedEnumeration share setting is disabled ,
Enabled: smbAccessBasedEnumeration share setting is enabled ,
}
,
Required: False ,
}
enum ,
smbNonBrowsable:
{
Description: Enables non-browsable property for SMB Shares. Only applicable for SMB/DualProtocol volume ,
Enum:
{
Disabled: smbNonBrowsable share setting is disabled ,
Enabled: smbNonBrowsable share setting is enabled ,
}
,
Required: False ,
}
enum ,
}
,
throughputMibps:
{
Description: Maximum throughput in MiB/s that can be achieved by this cache volume and this will be accepted as input only for manual qosType cache ,
Format: float ,
Required: False ,
}
number ,
keyVaultPrivateEndpointResourceId:
{
Description: The resource ID of private endpoint for KeyVault. It must reside in the same VNET as the volume. Only applicable if encryptionKeySource = 'Microsoft.KeyVault'. ,
Format: arm-id ,
Required: False ,
}
string ,
cifsChangeNotifications:
{
Description: Flag indicating whether a CIFS change notification is enabled for the cache. ,
Enum:
{
Disabled: CIFS change notification is disabled ,
Enabled: CIFS change notification is enabled ,
}
,
Required: False ,
}
enum ,
writeBack:
{
Description: Flag indicating whether writeback is enabled for the cache. ,
Enum:
{
Disabled: Writeback cache is disabled ,
Enabled: Writeback cache is enabled ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Cache properties ,
Required: True ,
}
{
filepath:
{
Description: The file path of the Cache. ,
Required: True ,
}
string ,
size:
{
Description: Maximum storage quota allowed for a file system in bytes. Valid values are in the range 50GiB to 1PiB. Values expressed in bytes as multiples of 1GiB. ,
Format: int64 ,
Required: True ,
}
integer ,
exportPolicy:
{
Description: Set of export policy rules ,
Required: False ,
}
{
rules:
{
Description: Export policy rule ,
Required: False ,
}
[
{
ruleIndex:
{
Description: Order index ,
Format: int32 ,
Required: False ,
}
integer ,
unixReadOnly:
{
Description: Read only access ,
Required: False ,
}
boolean ,
unixReadWrite:
{
Description: Read and write access ,
Required: False ,
}
boolean ,
kerberos5ReadOnly:
{
Description: Kerberos5 Read only access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5ReadWrite:
{
Description: Kerberos5 Read and write access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5iReadOnly:
{
Description: Kerberos5i Read only access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5iReadWrite:
{
Description: Kerberos5i Read and write access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5pReadOnly:
{
Description: Kerberos5p Read only access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5pReadWrite:
{
Description: Kerberos5p Read and write access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
cifs:
{
Description: Allows CIFS protocol ,
Required: False ,
}
boolean ,
nfsv3:
{
Description: Allows NFSv3 protocol. Enable only for NFSv3 type volumes ,
Required: False ,
}
boolean ,
nfsv41:
{
Description: Allows NFSv4.1 protocol. Enable only for NFSv4.1 type volumes ,
Required: False ,
}
boolean ,
allowedClients:
{
Description: Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names ,
Required: False ,
}
string ,
hasRootAccess:
{
Description: Has root access to volume ,
Required: False ,
}
boolean ,
chownMode:
{
Description: This parameter specifies who is authorized to change the ownership of a file. restricted - Only root user can change the ownership of the file. unrestricted - Non-root users can change ownership of files that they own. ,
Enum:
{
Restricted: No description available. ,
Unrestricted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
protocolTypes:
{
Description: Set of supported protocol types, which include NFSv3, NFSv4 and SMB protocol ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: Azure lifecycle management ,
Enum:
{
Creating: The resource is being created. ,
Updating: The resource is being updated. ,
Deleting: The resource is being deleted. ,
Failed: The resource is in a failed state. ,
Succeeded: The resource is succeeded. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
cacheState:
{
Description: Azure NetApp Files Cache lifecycle management ,
Enum:
{
ClusterPeeringOfferSent: Cluster peering offer has been sent. ,
VserverPeeringOfferSent: VServer peering offer has been sent. ,
Creating: Cache creation in progress. ,
Succeeded: Cache creation succeeded and is available for use. ,
Failed: Cache is in a failed state ,
}
,
Required: False ,
}
enum ,
cacheSubnetResourceId:
{
Description: The Azure Resource URI for a delegated cache subnet that will be used to allocate data IPs. ,
Format: arm-id ,
Required: True ,
}
string ,
peeringSubnetResourceId:
{
Description: The Azure Resource URI for a delegated subnet that will be used for ANF Intercluster Interface IP addresses. ,
Format: arm-id ,
Required: True ,
}
string ,
mountTargets:
{
Description: List of mount targets that can be used to mount this cache ,
Required: False ,
}
[
{
mountTargetId:
{
Description: UUID v4 used to identify the MountTarget ,
Required: False ,
}
string ,
ipAddress:
{
Description: The mount target's IPv4 address, used to mount the cache. ,
Required: False ,
}
string ,
smbServerFqdn:
{
Description: The SMB server's Fully Qualified Domain Name, FQDN ,
Required: False ,
}
string ,
}
,
]
,
kerberos:
{
Description: Describe if a cache is Kerberos enabled. ,
Enum:
{
Disabled: Kerberos is disabled ,
Enabled: Kerberos is enabled ,
}
,
Required: False ,
}
enum ,
smbSettings:
{
Description: SMB information for the cache ,
Required: False ,
}
{
smbEncryption:
{
Description: Enables encryption for in-flight smb3 data. Only applicable for SMB/DualProtocol cache. ,
Enum:
{
Disabled: SMB encryption is disabled ,
Enabled: SMB encryption is enabled ,
}
,
Required: False ,
}
enum ,
smbAccessBasedEnumerations:
{
Description: Enables access-based enumeration share property for SMB Shares. Only applicable for SMB/DualProtocol volume ,
Enum:
{
Disabled: smbAccessBasedEnumeration share setting is disabled ,
Enabled: smbAccessBasedEnumeration share setting is enabled ,
}
,
Required: False ,
}
enum ,
smbNonBrowsable:
{
Description: Enables non-browsable property for SMB Shares. Only applicable for SMB/DualProtocol volume ,
Enum:
{
Disabled: smbNonBrowsable share setting is disabled ,
Enabled: smbNonBrowsable share setting is enabled ,
}
,
Required: False ,
}
enum ,
}
,
throughputMibps:
{
Description: Maximum throughput in MiB/s that can be achieved by this cache volume and this will be accepted as input only for manual qosType cache ,
Format: float ,
Required: False ,
}
number ,
actualThroughputMibps:
{
Description: Actual throughput in MiB/s for auto qosType volumes calculated based on size and serviceLevel ,
Format: float ,
Required: False ,
}
number ,
encryptionKeySource:
{
Description: Source of key used to encrypt data in the cache. Applicable if NetApp account has encryption.keySource = 'Microsoft.KeyVault'. Possible values (case-insensitive) are: 'Microsoft.NetApp, Microsoft.KeyVault' ,
Enum:
{
Microsoft.NetApp: Microsoft-managed key encryption ,
Microsoft.KeyVault: Customer-managed key encryption ,
}
,
Required: True ,
}
enum ,
keyVaultPrivateEndpointResourceId:
{
Description: The resource ID of private endpoint for KeyVault. It must reside in the same VNET as the volume. Only applicable if encryptionKeySource = 'Microsoft.KeyVault'. ,
Format: arm-id ,
Required: False ,
}
string ,
maximumNumberOfFiles:
{
Description: Maximum number of files allowed. ,
Format: int64 ,
Required: False ,
}
integer ,
encryption:
{
Description: Specifies if the cache is encryption or not. ,
Enum:
{
Disabled: Encryption is disabled ,
Enabled: Encryption is enabled ,
}
,
Required: False ,
}
enum ,
language:
{
Description: Language supported for volume. ,
Enum:
{
c.utf-8: Posix with UTF-8 ,
utf8mb4: UTF-8 with 4 byte character support ,
ar: Arabic - Deprecated ,
ar.utf-8: Arabic with UTF-8 ,
hr: Croatian - Deprecated ,
hr.utf-8: Croatian with UTF-8 ,
cs: Czech - Deprecated ,
cs.utf-8: Czech with UTF-8 ,
da: Danish - Deprecated ,
da.utf-8: Danish with UTF-8 ,
nl: Dutch - Deprecated ,
nl.utf-8: Dutch with UTF-8 ,
en: English - Deprecated ,
en.utf-8: English with UTF-8 ,
fi: Finnish - Deprecated ,
fi.utf-8: Finnish with UTF-8 ,
fr: French - Deprecated ,
fr.utf-8: French with UTF-8 ,
de: German - Deprecated ,
de.utf-8: German with UTF-8 ,
he: Hebrew - Deprecated ,
he.utf-8: Hebrew with UTF-8 ,
hu: Hungarian - Deprecated ,
hu.utf-8: Hungarian with UTF-8 ,
it: Italian - Deprecated ,
it.utf-8: Italian with UTF-8 ,
ja: Japanese euc-j - Deprecated ,
ja.utf-8: Japanese euc-j with UTF-8 ,
ja-v1: Japanese euc-j - Deprecated ,
ja-v1.utf-8: Japanese euc-j with UTF-8 ,
ja-jp.pck: Japanese pck ,
ja-jp.pck.utf-8: Japanese pck with UTF-8 - Deprecated ,
ja-jp.932: Japanese cp932 ,
ja-jp.932.utf-8: Japanese cp932 with UTF-8 - Deprecated ,
ja-jp.pck-v2: Japanese pck - sjis ,
ja-jp.pck-v2.utf-8: Japanese pck - sjis with UTF-8 - Deprecated ,
ko: Korean - Deprecated ,
ko.utf-8: Korean with UTF-8 ,
no: Norwegian - Deprecated ,
no.utf-8: Norwegian with UTF-8 ,
pl: Polish - Deprecated ,
pl.utf-8: Polish with UTF-8 ,
pt: Portuguese - Deprecated ,
pt.utf-8: Portuguese with UTF-8 ,
c: Posix - Deprecated ,
ro: Romanian - Deprecated ,
ro.utf-8: Romanian with UTF-8 ,
ru: Russian - Deprecated ,
ru.utf-8: Russian with UTF-8 ,
zh: Simplified Chinese - Deprecated ,
zh.utf-8: Simplified Chinese with UTF-8 ,
zh.gbk: Simplified gbk Chinese ,
zh.gbk.utf-8: Simplified gbk Chinese with UTF-8 - Deprecated ,
zh-tw.big5: Traditional Chinese BIG 5 ,
zh-tw.big5.utf-8: Traditional Chinese BIG 5 with UTF-8 - Deprecated ,
zh-tw: Traditional Chinese EUC-TW ,
zh-tw.utf-8: Traditional Chinese EUC-TW with UTF-8 - Deprecated ,
sk: Slovak - Deprecated ,
sk.utf-8: Slovak with UTF-8 ,
sl: Slovenian - Deprecated ,
sl.utf-8: Slovenian with UTF-8 ,
es: Spanish - Deprecated ,
es.utf-8: Spanish with UTF-8 ,
sv: Swedish - Deprecated ,
sv.utf-8: Swedish with UTF-8 ,
tr: Turkish - Deprecated ,
tr.utf-8: Turkish with UTF-8 ,
en-us: US English - Deprecated ,
en-us.utf-8: US English with UTF-8 ,
}
,
Required: False ,
}
enum ,
ldap:
{
Description: Specifies whether LDAP is enabled or not for flexcache volume. ,
Enum:
{
Disabled: ldap is disabled. ,
Enabled: ldap is enabled ,
}
,
Required: False ,
}
enum ,
ldapServerType:
{
Description: Specifies the type of LDAP server for flexcache volume. ,
Enum:
{
ActiveDirectory: The volume should use Active Directory for LDAP connections. ,
OpenLDAP: The volume should use OpenLDAP for LDAP connections. ,
}
,
Required: False ,
}
enum ,
originClusterInformation:
{
Description: Origin cluster information ,
Required: True ,
}
{
peerClusterName:
{
Description: ONTAP cluster name of external cluster hosting the origin volume ,
Required: True ,
}
string ,
peerAddresses:
{
Description: ONTAP Intercluster LIF IP addresses. One IP address per cluster node is required ,
Required: True ,
}
[
string ,
]
,
peerVserverName:
{
Description: External Vserver (SVM) name name of the SVM hosting the origin volume ,
Required: True ,
}
string ,
peerVolumeName:
{
Description: External origin volume name associated to this cache ,
Required: True ,
}
string ,
}
,
cifsChangeNotifications:
{
Description: Flag indicating whether a CIFS change notification is enabled for the cache. ,
Enum:
{
Disabled: CIFS change notification is disabled ,
Enabled: CIFS change notification is enabled ,
}
,
Required: False ,
}
enum ,
globalFileLocking:
{
Description: Flag indicating whether the global file lock is enabled for the cache. ,
Enum:
{
Disabled: Global file locking is disabled ,
Enabled: Global file locking is enabled ,
}
,
Required: False ,
}
enum ,
writeBack:
{
Description: Flag indicating whether writeback is enabled for the cache. ,
Enum:
{
Disabled: Writeback cache is disabled ,
Enabled: Writeback cache is enabled ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
zones:
{
Description: The availability zones. ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Caches_PoolChange (updated)
Description :  Moves Cache to another Capacity Pool
Reference :  Link ¶

⚶ Changes

{
  "#id": "Caches_PoolChange",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "exportPolicy",
            "Type": {
              "new": "object",
              "old": "array"
            }
          },
          {
            "#name": "protocolTypes",
            "Description": {
              "new": "Set of supported protocol types, which include NFSv3, NFSv4 and SMB protocol",
              "old": "Set of protocol types, default NFSv3, CIFS for SMB protocol"
            },
            "$items": {
              "Description": {
                "new": "Set of supported protocol types, which include NFSv3, NFSv4 and SMB protocol",
                "old": "Export policy rule"
              }
            }
          }
        ]
      }
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/caches/{cacheName}/poolChange
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the NetApp account ,
Required: True ,
}
string ,
poolName:
{
Description: The name of the capacity pool ,
Required: True ,
}
string ,
cacheName:
{
Description: The name of the cache resource. ,
Required: True ,
}
string ,
body:
{
Description: Move cache to the pool supplied in the body of the operation. ,
Required: True ,
}
{
newPoolResourceId:
{
Description: Resource id of the pool to move volume to ,
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Cache properties ,
Required: True ,
}
{
filepath:
{
Description: The file path of the Cache. ,
Required: True ,
}
string ,
size:
{
Description: Maximum storage quota allowed for a file system in bytes. Valid values are in the range 50GiB to 1PiB. Values expressed in bytes as multiples of 1GiB. ,
Format: int64 ,
Required: True ,
}
integer ,
exportPolicy:
{
Description: Set of export policy rules ,
Required: False ,
}
{
rules:
{
Description: Export policy rule ,
Required: False ,
}
[
{
ruleIndex:
{
Description: Order index ,
Format: int32 ,
Required: False ,
}
integer ,
unixReadOnly:
{
Description: Read only access ,
Required: False ,
}
boolean ,
unixReadWrite:
{
Description: Read and write access ,
Required: False ,
}
boolean ,
kerberos5ReadOnly:
{
Description: Kerberos5 Read only access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5ReadWrite:
{
Description: Kerberos5 Read and write access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5iReadOnly:
{
Description: Kerberos5i Read only access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5iReadWrite:
{
Description: Kerberos5i Read and write access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5pReadOnly:
{
Description: Kerberos5p Read only access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5pReadWrite:
{
Description: Kerberos5p Read and write access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
cifs:
{
Description: Allows CIFS protocol ,
Required: False ,
}
boolean ,
nfsv3:
{
Description: Allows NFSv3 protocol. Enable only for NFSv3 type volumes ,
Required: False ,
}
boolean ,
nfsv41:
{
Description: Allows NFSv4.1 protocol. Enable only for NFSv4.1 type volumes ,
Required: False ,
}
boolean ,
allowedClients:
{
Description: Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names ,
Required: False ,
}
string ,
hasRootAccess:
{
Description: Has root access to volume ,
Required: False ,
}
boolean ,
chownMode:
{
Description: This parameter specifies who is authorized to change the ownership of a file. restricted - Only root user can change the ownership of the file. unrestricted - Non-root users can change ownership of files that they own. ,
Enum:
{
Restricted: No description available. ,
Unrestricted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
protocolTypes:
{
Description: Set of supported protocol types, which include NFSv3, NFSv4 and SMB protocol ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: Azure lifecycle management ,
Enum:
{
Creating: The resource is being created. ,
Updating: The resource is being updated. ,
Deleting: The resource is being deleted. ,
Failed: The resource is in a failed state. ,
Succeeded: The resource is succeeded. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
cacheState:
{
Description: Azure NetApp Files Cache lifecycle management ,
Enum:
{
ClusterPeeringOfferSent: Cluster peering offer has been sent. ,
VserverPeeringOfferSent: VServer peering offer has been sent. ,
Creating: Cache creation in progress. ,
Succeeded: Cache creation succeeded and is available for use. ,
Failed: Cache is in a failed state ,
}
,
Required: False ,
}
enum ,
cacheSubnetResourceId:
{
Description: The Azure Resource URI for a delegated cache subnet that will be used to allocate data IPs. ,
Format: arm-id ,
Required: True ,
}
string ,
peeringSubnetResourceId:
{
Description: The Azure Resource URI for a delegated subnet that will be used for ANF Intercluster Interface IP addresses. ,
Format: arm-id ,
Required: True ,
}
string ,
mountTargets:
{
Description: List of mount targets that can be used to mount this cache ,
Required: False ,
}
[
{
mountTargetId:
{
Description: UUID v4 used to identify the MountTarget ,
Required: False ,
}
string ,
ipAddress:
{
Description: The mount target's IPv4 address, used to mount the cache. ,
Required: False ,
}
string ,
smbServerFqdn:
{
Description: The SMB server's Fully Qualified Domain Name, FQDN ,
Required: False ,
}
string ,
}
,
]
,
kerberos:
{
Description: Describe if a cache is Kerberos enabled. ,
Enum:
{
Disabled: Kerberos is disabled ,
Enabled: Kerberos is enabled ,
}
,
Required: False ,
}
enum ,
smbSettings:
{
Description: SMB information for the cache ,
Required: False ,
}
{
smbEncryption:
{
Description: Enables encryption for in-flight smb3 data. Only applicable for SMB/DualProtocol cache. ,
Enum:
{
Disabled: SMB encryption is disabled ,
Enabled: SMB encryption is enabled ,
}
,
Required: False ,
}
enum ,
smbAccessBasedEnumerations:
{
Description: Enables access-based enumeration share property for SMB Shares. Only applicable for SMB/DualProtocol volume ,
Enum:
{
Disabled: smbAccessBasedEnumeration share setting is disabled ,
Enabled: smbAccessBasedEnumeration share setting is enabled ,
}
,
Required: False ,
}
enum ,
smbNonBrowsable:
{
Description: Enables non-browsable property for SMB Shares. Only applicable for SMB/DualProtocol volume ,
Enum:
{
Disabled: smbNonBrowsable share setting is disabled ,
Enabled: smbNonBrowsable share setting is enabled ,
}
,
Required: False ,
}
enum ,
}
,
throughputMibps:
{
Description: Maximum throughput in MiB/s that can be achieved by this cache volume and this will be accepted as input only for manual qosType cache ,
Format: float ,
Required: False ,
}
number ,
actualThroughputMibps:
{
Description: Actual throughput in MiB/s for auto qosType volumes calculated based on size and serviceLevel ,
Format: float ,
Required: False ,
}
number ,
encryptionKeySource:
{
Description: Source of key used to encrypt data in the cache. Applicable if NetApp account has encryption.keySource = 'Microsoft.KeyVault'. Possible values (case-insensitive) are: 'Microsoft.NetApp, Microsoft.KeyVault' ,
Enum:
{
Microsoft.NetApp: Microsoft-managed key encryption ,
Microsoft.KeyVault: Customer-managed key encryption ,
}
,
Required: True ,
}
enum ,
keyVaultPrivateEndpointResourceId:
{
Description: The resource ID of private endpoint for KeyVault. It must reside in the same VNET as the volume. Only applicable if encryptionKeySource = 'Microsoft.KeyVault'. ,
Format: arm-id ,
Required: False ,
}
string ,
maximumNumberOfFiles:
{
Description: Maximum number of files allowed. ,
Format: int64 ,
Required: False ,
}
integer ,
encryption:
{
Description: Specifies if the cache is encryption or not. ,
Enum:
{
Disabled: Encryption is disabled ,
Enabled: Encryption is enabled ,
}
,
Required: False ,
}
enum ,
language:
{
Description: Language supported for volume. ,
Enum:
{
c.utf-8: Posix with UTF-8 ,
utf8mb4: UTF-8 with 4 byte character support ,
ar: Arabic - Deprecated ,
ar.utf-8: Arabic with UTF-8 ,
hr: Croatian - Deprecated ,
hr.utf-8: Croatian with UTF-8 ,
cs: Czech - Deprecated ,
cs.utf-8: Czech with UTF-8 ,
da: Danish - Deprecated ,
da.utf-8: Danish with UTF-8 ,
nl: Dutch - Deprecated ,
nl.utf-8: Dutch with UTF-8 ,
en: English - Deprecated ,
en.utf-8: English with UTF-8 ,
fi: Finnish - Deprecated ,
fi.utf-8: Finnish with UTF-8 ,
fr: French - Deprecated ,
fr.utf-8: French with UTF-8 ,
de: German - Deprecated ,
de.utf-8: German with UTF-8 ,
he: Hebrew - Deprecated ,
he.utf-8: Hebrew with UTF-8 ,
hu: Hungarian - Deprecated ,
hu.utf-8: Hungarian with UTF-8 ,
it: Italian - Deprecated ,
it.utf-8: Italian with UTF-8 ,
ja: Japanese euc-j - Deprecated ,
ja.utf-8: Japanese euc-j with UTF-8 ,
ja-v1: Japanese euc-j - Deprecated ,
ja-v1.utf-8: Japanese euc-j with UTF-8 ,
ja-jp.pck: Japanese pck ,
ja-jp.pck.utf-8: Japanese pck with UTF-8 - Deprecated ,
ja-jp.932: Japanese cp932 ,
ja-jp.932.utf-8: Japanese cp932 with UTF-8 - Deprecated ,
ja-jp.pck-v2: Japanese pck - sjis ,
ja-jp.pck-v2.utf-8: Japanese pck - sjis with UTF-8 - Deprecated ,
ko: Korean - Deprecated ,
ko.utf-8: Korean with UTF-8 ,
no: Norwegian - Deprecated ,
no.utf-8: Norwegian with UTF-8 ,
pl: Polish - Deprecated ,
pl.utf-8: Polish with UTF-8 ,
pt: Portuguese - Deprecated ,
pt.utf-8: Portuguese with UTF-8 ,
c: Posix - Deprecated ,
ro: Romanian - Deprecated ,
ro.utf-8: Romanian with UTF-8 ,
ru: Russian - Deprecated ,
ru.utf-8: Russian with UTF-8 ,
zh: Simplified Chinese - Deprecated ,
zh.utf-8: Simplified Chinese with UTF-8 ,
zh.gbk: Simplified gbk Chinese ,
zh.gbk.utf-8: Simplified gbk Chinese with UTF-8 - Deprecated ,
zh-tw.big5: Traditional Chinese BIG 5 ,
zh-tw.big5.utf-8: Traditional Chinese BIG 5 with UTF-8 - Deprecated ,
zh-tw: Traditional Chinese EUC-TW ,
zh-tw.utf-8: Traditional Chinese EUC-TW with UTF-8 - Deprecated ,
sk: Slovak - Deprecated ,
sk.utf-8: Slovak with UTF-8 ,
sl: Slovenian - Deprecated ,
sl.utf-8: Slovenian with UTF-8 ,
es: Spanish - Deprecated ,
es.utf-8: Spanish with UTF-8 ,
sv: Swedish - Deprecated ,
sv.utf-8: Swedish with UTF-8 ,
tr: Turkish - Deprecated ,
tr.utf-8: Turkish with UTF-8 ,
en-us: US English - Deprecated ,
en-us.utf-8: US English with UTF-8 ,
}
,
Required: False ,
}
enum ,
ldap:
{
Description: Specifies whether LDAP is enabled or not for flexcache volume. ,
Enum:
{
Disabled: ldap is disabled. ,
Enabled: ldap is enabled ,
}
,
Required: False ,
}
enum ,
ldapServerType:
{
Description: Specifies the type of LDAP server for flexcache volume. ,
Enum:
{
ActiveDirectory: The volume should use Active Directory for LDAP connections. ,
OpenLDAP: The volume should use OpenLDAP for LDAP connections. ,
}
,
Required: False ,
}
enum ,
originClusterInformation:
{
Description: Origin cluster information ,
Required: True ,
}
{
peerClusterName:
{
Description: ONTAP cluster name of external cluster hosting the origin volume ,
Required: True ,
}
string ,
peerAddresses:
{
Description: ONTAP Intercluster LIF IP addresses. One IP address per cluster node is required ,
Required: True ,
}
[
string ,
]
,
peerVserverName:
{
Description: External Vserver (SVM) name name of the SVM hosting the origin volume ,
Required: True ,
}
string ,
peerVolumeName:
{
Description: External origin volume name associated to this cache ,
Required: True ,
}
string ,
}
,
cifsChangeNotifications:
{
Description: Flag indicating whether a CIFS change notification is enabled for the cache. ,
Enum:
{
Disabled: CIFS change notification is disabled ,
Enabled: CIFS change notification is enabled ,
}
,
Required: False ,
}
enum ,
globalFileLocking:
{
Description: Flag indicating whether the global file lock is enabled for the cache. ,
Enum:
{
Disabled: Global file locking is disabled ,
Enabled: Global file locking is enabled ,
}
,
Required: False ,
}
enum ,
writeBack:
{
Description: Flag indicating whether writeback is enabled for the cache. ,
Enum:
{
Disabled: Writeback cache is disabled ,
Enabled: Writeback cache is enabled ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
zones:
{
Description: The availability zones. ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}