Microsoft.NetApp (preview:2017-08-15)

2025/10/30 • 22 new, 22 deleted methods

Operations_List (new)
Description :  Lists all of the available Microsoft.NetApp Rest API operations
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.NetApp/operations
{
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Storage operations supported by the Storage resource provider. ,
Required: False ,
}
[
{
name:
{
Description: Operation name: {provider}/{resource}/{operation} ,
Required: False ,
}
string ,
display:
{
Description: Display metadata associated with the operation. ,
Required: False ,
}
{
provider:
{
Description: Service provider: Microsoft NetApp. ,
Required: False ,
}
string ,
resource:
{
Description: Resource on which the operation is performed etc. ,
Required: False ,
}
string ,
operation:
{
Description: Type of operation: get, read, delete, etc. ,
Required: False ,
}
string ,
description:
{
Description: Operation description. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The origin of operations. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of operation, include metric specifications. ,
Required: False ,
}
{
serviceSpecification:
{
Description: One property of operation, include metric specifications. ,
Required: False ,
}
{
metricSpecifications:
{
Description: Metric specifications of operation. ,
Required: False ,
}
[
{
name:
{
Description: Name of metric specification. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of metric specification. ,
Required: False ,
}
string ,
displayDescription:
{
Description: Display description of metric specification. ,
Required: False ,
}
string ,
unit:
{
Description: Unit could be Bytes or Count. ,
Required: False ,
}
string ,
dimensions:
{
Description: Dimensions of blobs, including blob type and access tier. ,
Required: False ,
}
[
{
name:
{
Description: Display name of dimension. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of dimension. ,
Required: False ,
}
string ,
}
,
]
,
aggregationType:
{
Description: Aggregation type could be Average. ,
Required: False ,
}
string ,
fillGapWithZero:
{
Description: The property to decide fill gap with zero or not. ,
Required: False ,
}
boolean ,
category:
{
Description: The category this metric specification belong to, could be Capacity. ,
Required: False ,
}
string ,
resourceIdDimensionNameOverride:
{
Description: Account Resource Id. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
]
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: True ,
}
string ,
message:
{
Description: Detailed error message ,
Required: True ,
}
string ,
}
Accounts_List (new)
Description :  Lists all NetApp accounts in the resource group
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts
{}

⚐ Response (200)

{
value:
{
Description: Multiple NetApp accounts ,
Required: False ,
}
[
{
location:
{
Description: Resource location ,
Required: True ,
}
string ,
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
name:
{
Description: Resource name ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
properties:
{
Description: NetApp Account properties ,
Required: True ,
}
{
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
activeDirectories:
{
Description: Active Directories ,
Required: False ,
}
[
{
activeDirectoryId:
{
Description: Id of the Active Directory ,
Required: False ,
}
string ,
username:
{
Description: Username of Active Directory domain administrator ,
Required: False ,
}
string ,
password:
{
Description: Plain text password of Active Directory domain administrator ,
Required: False ,
}
string ,
domain:
{
Description: Name of the Active Directory domain ,
Required: False ,
}
string ,
dNS:
{
Description: Comma separated list of DNS server IP addresses for the Active Directory domain ,
Required: False ,
}
string ,
status:
{
Description: Status of 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 ,
}
,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: True ,
}
string ,
message:
{
Description: Detailed error message ,
Required: True ,
}
string ,
}
Accounts_Get (new)
Description :  Get the NetApp account
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}
{}

⚐ Response (200)

{
location:
{
Description: Resource location ,
Required: True ,
}
string ,
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
name:
{
Description: Resource name ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
properties:
{
Description: NetApp Account properties ,
Required: True ,
}
{
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
activeDirectories:
{
Description: Active Directories ,
Required: False ,
}
[
{
activeDirectoryId:
{
Description: Id of the Active Directory ,
Required: False ,
}
string ,
username:
{
Description: Username of Active Directory domain administrator ,
Required: False ,
}
string ,
password:
{
Description: Plain text password of Active Directory domain administrator ,
Required: False ,
}
string ,
domain:
{
Description: Name of the Active Directory domain ,
Required: False ,
}
string ,
dNS:
{
Description: Comma separated list of DNS server IP addresses for the Active Directory domain ,
Required: False ,
}
string ,
status:
{
Description: Status of 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 ,
}
,
]
,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: True ,
}
string ,
message:
{
Description: Detailed error message ,
Required: True ,
}
string ,
}
Accounts_CreateOrUpdate (new)
Description :  Create or update a NetApp account
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}
{
body:
{
Description: NetApp Account object supplied in the body of the operation. ,
Required: True ,
}
{
location:
{
Description: Resource location ,
Required: True ,
}
string ,
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
name:
{
Description: Resource name ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
properties:
{
Description: NetApp Account properties ,
Required: True ,
}
{
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
activeDirectories:
{
Description: Active Directories ,
Required: False ,
}
[
{
activeDirectoryId:
{
Description: Id of the Active Directory ,
Required: False ,
}
string ,
username:
{
Description: Username of Active Directory domain administrator ,
Required: False ,
}
string ,
password:
{
Description: Plain text password of Active Directory domain administrator ,
Required: False ,
}
string ,
domain:
{
Description: Name of the Active Directory domain ,
Required: False ,
}
string ,
dNS:
{
Description: Comma separated list of DNS server IP addresses for the Active Directory domain ,
Required: False ,
}
string ,
status:
{
Description: Status of 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 ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
location:
{
Description: Resource location ,
Required: True ,
}
string ,
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
name:
{
Description: Resource name ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
properties:
{
Description: NetApp Account properties ,
Required: True ,
}
{
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
activeDirectories:
{
Description: Active Directories ,
Required: False ,
}
[
{
activeDirectoryId:
{
Description: Id of the Active Directory ,
Required: False ,
}
string ,
username:
{
Description: Username of Active Directory domain administrator ,
Required: False ,
}
string ,
password:
{
Description: Plain text password of Active Directory domain administrator ,
Required: False ,
}
string ,
domain:
{
Description: Name of the Active Directory domain ,
Required: False ,
}
string ,
dNS:
{
Description: Comma separated list of DNS server IP addresses for the Active Directory domain ,
Required: False ,
}
string ,
status:
{
Description: Status of 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 ,
}
,
]
,
}
,
}

⚐ Response (201)

{
location:
{
Description: Resource location ,
Required: True ,
}
string ,
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
name:
{
Description: Resource name ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
properties:
{
Description: NetApp Account properties ,
Required: True ,
}
{
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
activeDirectories:
{
Description: Active Directories ,
Required: False ,
}
[
{
activeDirectoryId:
{
Description: Id of the Active Directory ,
Required: False ,
}
string ,
username:
{
Description: Username of Active Directory domain administrator ,
Required: False ,
}
string ,
password:
{
Description: Plain text password of Active Directory domain administrator ,
Required: False ,
}
string ,
domain:
{
Description: Name of the Active Directory domain ,
Required: False ,
}
string ,
dNS:
{
Description: Comma separated list of DNS server IP addresses for the Active Directory domain ,
Required: False ,
}
string ,
status:
{
Description: Status of 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 ,
}
,
]
,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: True ,
}
string ,
message:
{
Description: Detailed error message ,
Required: True ,
}
string ,
}
Accounts_Delete (new)
Description :  Delete a NetApp account
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}
{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: True ,
}
string ,
message:
{
Description: Detailed error message ,
Required: True ,
}
string ,
}
Accounts_Update (new)
Description :  Patch a NetApp account
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}
{
body:
{
Description: NetApp Account object supplied in the body of the operation. ,
Required: True ,
}
{
location:
{
Description: Resource location ,
Required: False ,
}
string ,
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
name:
{
Description: Resource name ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
properties:
{
Description: NetApp Account properties ,
Required: False ,
}
{
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
activeDirectories:
{
Description: Active Directories ,
Required: False ,
}
[
{
activeDirectoryId:
{
Description: Id of the Active Directory ,
Required: False ,
}
string ,
username:
{
Description: Username of Active Directory domain administrator ,
Required: False ,
}
string ,
password:
{
Description: Plain text password of Active Directory domain administrator ,
Required: False ,
}
string ,
domain:
{
Description: Name of the Active Directory domain ,
Required: False ,
}
string ,
dNS:
{
Description: Comma separated list of DNS server IP addresses for the Active Directory domain ,
Required: False ,
}
string ,
status:
{
Description: Status of 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 ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
location:
{
Description: Resource location ,
Required: True ,
}
string ,
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
name:
{
Description: Resource name ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
properties:
{
Description: NetApp Account properties ,
Required: True ,
}
{
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
activeDirectories:
{
Description: Active Directories ,
Required: False ,
}
[
{
activeDirectoryId:
{
Description: Id of the Active Directory ,
Required: False ,
}
string ,
username:
{
Description: Username of Active Directory domain administrator ,
Required: False ,
}
string ,
password:
{
Description: Plain text password of Active Directory domain administrator ,
Required: False ,
}
string ,
domain:
{
Description: Name of the Active Directory domain ,
Required: False ,
}
string ,
dNS:
{
Description: Comma separated list of DNS server IP addresses for the Active Directory domain ,
Required: False ,
}
string ,
status:
{
Description: Status of 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 ,
}
,
]
,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: True ,
}
string ,
message:
{
Description: Detailed error message ,
Required: True ,
}
string ,
}
Pools_List (new)
Description :  Lists all capacity pools in the NetApp Account
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools
{}

⚐ Response (200)

{
value:
{
Description: List of Capacity pools ,
Required: False ,
}
[
{
location:
{
Description: Resource location ,
Required: True ,
}
string ,
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
name:
{
Description: Resource name ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
properties:
{
Description: Capacity pool properties ,
Required: True ,
}
{
poolId:
{
Description: UUID v4 used to identify the Pool ,
Required: False ,
}
string ,
size:
{
Description: Provisioned size of the pool (in bytes). Allowed values are in 4TiB chunks (value must be multiply of 4398046511104). ,
Format: int64 ,
Required: False ,
}
integer ,
serviceLevel:
{
Description: The service level of the file system ,
Enum:
{
Standard: Standard service level ,
Premium: Premium service level ,
Ultra: Ultra service level ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: True ,
}
string ,
message:
{
Description: Detailed error message ,
Required: True ,
}
string ,
}
Pools_Get (new)
Description :  Get a capacity pool
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}
{}

⚐ Response (200)

{
location:
{
Description: Resource location ,
Required: True ,
}
string ,
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
name:
{
Description: Resource name ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
properties:
{
Description: Capacity pool properties ,
Required: True ,
}
{
poolId:
{
Description: UUID v4 used to identify the Pool ,
Required: False ,
}
string ,
size:
{
Description: Provisioned size of the pool (in bytes). Allowed values are in 4TiB chunks (value must be multiply of 4398046511104). ,
Format: int64 ,
Required: False ,
}
integer ,
serviceLevel:
{
Description: The service level of the file system ,
Enum:
{
Standard: Standard service level ,
Premium: Premium service level ,
Ultra: Ultra service level ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: True ,
}
string ,
message:
{
Description: Detailed error message ,
Required: True ,
}
string ,
}
Pools_CreateOrUpdate (new)
Description :  Create or Update a capacity pool
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}
{
body:
{
Description: Capacity pool object supplied in the body of the operation. ,
Required: True ,
}
{
location:
{
Description: Resource location ,
Required: True ,
}
string ,
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
name:
{
Description: Resource name ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
properties:
{
Description: Capacity pool properties ,
Required: True ,
}
{
poolId:
{
Description: UUID v4 used to identify the Pool ,
Required: False ,
}
string ,
size:
{
Description: Provisioned size of the pool (in bytes). Allowed values are in 4TiB chunks (value must be multiply of 4398046511104). ,
Format: int64 ,
Required: False ,
}
integer ,
serviceLevel:
{
Description: The service level of the file system ,
Enum:
{
Standard: Standard service level ,
Premium: Premium service level ,
Ultra: Ultra service level ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
location:
{
Description: Resource location ,
Required: True ,
}
string ,
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
name:
{
Description: Resource name ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
properties:
{
Description: Capacity pool properties ,
Required: True ,
}
{
poolId:
{
Description: UUID v4 used to identify the Pool ,
Required: False ,
}
string ,
size:
{
Description: Provisioned size of the pool (in bytes). Allowed values are in 4TiB chunks (value must be multiply of 4398046511104). ,
Format: int64 ,
Required: False ,
}
integer ,
serviceLevel:
{
Description: The service level of the file system ,
Enum:
{
Standard: Standard service level ,
Premium: Premium service level ,
Ultra: Ultra service level ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
location:
{
Description: Resource location ,
Required: True ,
}
string ,
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
name:
{
Description: Resource name ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
properties:
{
Description: Capacity pool properties ,
Required: True ,
}
{
poolId:
{
Description: UUID v4 used to identify the Pool ,
Required: False ,
}
string ,
size:
{
Description: Provisioned size of the pool (in bytes). Allowed values are in 4TiB chunks (value must be multiply of 4398046511104). ,
Format: int64 ,
Required: False ,
}
integer ,
serviceLevel:
{
Description: The service level of the file system ,
Enum:
{
Standard: Standard service level ,
Premium: Premium service level ,
Ultra: Ultra service level ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: True ,
}
string ,
message:
{
Description: Detailed error message ,
Required: True ,
}
string ,
}
Pools_Update (new)
Description :  Patch a capacity pool
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}
{
body:
{
Description: Capacity pool object supplied in the body of the operation. ,
Required: True ,
}
{
location:
{
Description: Resource location ,
Required: False ,
}
string ,
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
name:
{
Description: Resource name ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
properties:
{
Description: Capacity pool properties ,
Required: False ,
}
{
size:
{
Description: Provisioned size of the pool (in bytes). Allowed values are in 4TiB chunks (value must be multiply of 4398046511104). ,
Format: int64 ,
Required: False ,
}
integer ,
serviceLevel:
{
Description: The service level of the file system ,
Enum:
{
Standard: Standard service level ,
Premium: Premium service level ,
Ultra: Ultra service level ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
location:
{
Description: Resource location ,
Required: True ,
}
string ,
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
name:
{
Description: Resource name ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
properties:
{
Description: Capacity pool properties ,
Required: True ,
}
{
poolId:
{
Description: UUID v4 used to identify the Pool ,
Required: False ,
}
string ,
size:
{
Description: Provisioned size of the pool (in bytes). Allowed values are in 4TiB chunks (value must be multiply of 4398046511104). ,
Format: int64 ,
Required: False ,
}
integer ,
serviceLevel:
{
Description: The service level of the file system ,
Enum:
{
Standard: Standard service level ,
Premium: Premium service level ,
Ultra: Ultra service level ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: True ,
}
string ,
message:
{
Description: Detailed error message ,
Required: True ,
}
string ,
}
Pools_Delete (new)
Description :  Delete a capacity pool
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}
{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: True ,
}
string ,
message:
{
Description: Detailed error message ,
Required: True ,
}
string ,
}
Volumes_List (new)
Description :  List volumes
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes
{}

⚐ Response (200)

{
value:
{
Description: List of volumes ,
Required: False ,
}
[
{
location:
{
Description: Resource location ,
Required: True ,
}
string ,
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
name:
{
Description: Resource name ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
properties:
{
Description: Volume properties ,
Required: True ,
}
{
fileSystemId:
{
Description: Unique FileSystem Identifier. ,
Required: False ,
}
string ,
creationToken:
{
Description: A unique file path for the volume. Used when creating mount targets ,
Required: True ,
}
string ,
serviceLevel:
{
Description: The service level of the file system ,
Enum:
{
Standard: Standard service level ,
Premium: Premium service level ,
Ultra: Ultra service level ,
}
,
Required: True ,
}
enum ,
usageThreshold:
{
Description: Maximum storage quota allowed for a file system in bytes. This is a soft quota used for alerting only. Minimum size is 100 GiB. Upper limit is 100TiB. ,
Format: int64 ,
Required: False ,
}
integer ,
exportPolicy:
{
Description: Export policy rule ,
Required: False ,
}
{
rules:
{
Required: False ,
}
[
{
ruleIndex:
{
Description: Order index ,
Required: False ,
}
integer ,
unixReadOnly:
{
Description: Read only access ,
Required: False ,
}
boolean ,
unixReadWrite:
{
Description: Read and write access ,
Required: False ,
}
boolean ,
cifs:
{
Description: Allows CIFS protocol ,
Required: False ,
}
boolean ,
nfsv3:
{
Description: Allows NFSv3 protocol ,
Required: False ,
}
boolean ,
nfsv4:
{
Description: Allows NFSv4 protocol ,
Required: False ,
}
boolean ,
allowedClients:
{
Description: Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names ,
Required: False ,
}
string ,
}
,
]
,
}
,
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
subnetId:
{
Description: The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: True ,
}
string ,
message:
{
Description: Detailed error message ,
Required: True ,
}
string ,
}
Volumes_Get (new)
Description :  Get a volume
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}
{}

⚐ Response (200)

{
location:
{
Description: Resource location ,
Required: True ,
}
string ,
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
name:
{
Description: Resource name ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
properties:
{
Description: Volume properties ,
Required: True ,
}
{
fileSystemId:
{
Description: Unique FileSystem Identifier. ,
Required: False ,
}
string ,
creationToken:
{
Description: A unique file path for the volume. Used when creating mount targets ,
Required: True ,
}
string ,
serviceLevel:
{
Description: The service level of the file system ,
Enum:
{
Standard: Standard service level ,
Premium: Premium service level ,
Ultra: Ultra service level ,
}
,
Required: True ,
}
enum ,
usageThreshold:
{
Description: Maximum storage quota allowed for a file system in bytes. This is a soft quota used for alerting only. Minimum size is 100 GiB. Upper limit is 100TiB. ,
Format: int64 ,
Required: False ,
}
integer ,
exportPolicy:
{
Description: Export policy rule ,
Required: False ,
}
{
rules:
{
Required: False ,
}
[
{
ruleIndex:
{
Description: Order index ,
Required: False ,
}
integer ,
unixReadOnly:
{
Description: Read only access ,
Required: False ,
}
boolean ,
unixReadWrite:
{
Description: Read and write access ,
Required: False ,
}
boolean ,
cifs:
{
Description: Allows CIFS protocol ,
Required: False ,
}
boolean ,
nfsv3:
{
Description: Allows NFSv3 protocol ,
Required: False ,
}
boolean ,
nfsv4:
{
Description: Allows NFSv4 protocol ,
Required: False ,
}
boolean ,
allowedClients:
{
Description: Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names ,
Required: False ,
}
string ,
}
,
]
,
}
,
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
subnetId:
{
Description: The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: True ,
}
string ,
message:
{
Description: Detailed error message ,
Required: True ,
}
string ,
}
Volumes_CreateOrUpdate (new)
Description :  Create or update a volume
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}
{
body:
{
Description: Volume object supplied in the body of the operation. ,
Required: True ,
}
{
location:
{
Description: Resource location ,
Required: True ,
}
string ,
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
name:
{
Description: Resource name ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
properties:
{
Description: Volume properties ,
Required: True ,
}
{
fileSystemId:
{
Description: Unique FileSystem Identifier. ,
Required: False ,
}
string ,
creationToken:
{
Description: A unique file path for the volume. Used when creating mount targets ,
Required: True ,
}
string ,
serviceLevel:
{
Description: The service level of the file system ,
Enum:
{
Standard: Standard service level ,
Premium: Premium service level ,
Ultra: Ultra service level ,
}
,
Required: True ,
}
enum ,
usageThreshold:
{
Description: Maximum storage quota allowed for a file system in bytes. This is a soft quota used for alerting only. Minimum size is 100 GiB. Upper limit is 100TiB. ,
Format: int64 ,
Required: False ,
}
integer ,
exportPolicy:
{
Description: Export policy rule ,
Required: False ,
}
{
rules:
{
Required: False ,
}
[
{
ruleIndex:
{
Description: Order index ,
Required: False ,
}
integer ,
unixReadOnly:
{
Description: Read only access ,
Required: False ,
}
boolean ,
unixReadWrite:
{
Description: Read and write access ,
Required: False ,
}
boolean ,
cifs:
{
Description: Allows CIFS protocol ,
Required: False ,
}
boolean ,
nfsv3:
{
Description: Allows NFSv3 protocol ,
Required: False ,
}
boolean ,
nfsv4:
{
Description: Allows NFSv4 protocol ,
Required: False ,
}
boolean ,
allowedClients:
{
Description: Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names ,
Required: False ,
}
string ,
}
,
]
,
}
,
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
subnetId:
{
Description: The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
location:
{
Description: Resource location ,
Required: True ,
}
string ,
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
name:
{
Description: Resource name ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
properties:
{
Description: Volume properties ,
Required: True ,
}
{
fileSystemId:
{
Description: Unique FileSystem Identifier. ,
Required: False ,
}
string ,
creationToken:
{
Description: A unique file path for the volume. Used when creating mount targets ,
Required: True ,
}
string ,
serviceLevel:
{
Description: The service level of the file system ,
Enum:
{
Standard: Standard service level ,
Premium: Premium service level ,
Ultra: Ultra service level ,
}
,
Required: True ,
}
enum ,
usageThreshold:
{
Description: Maximum storage quota allowed for a file system in bytes. This is a soft quota used for alerting only. Minimum size is 100 GiB. Upper limit is 100TiB. ,
Format: int64 ,
Required: False ,
}
integer ,
exportPolicy:
{
Description: Export policy rule ,
Required: False ,
}
{
rules:
{
Required: False ,
}
[
{
ruleIndex:
{
Description: Order index ,
Required: False ,
}
integer ,
unixReadOnly:
{
Description: Read only access ,
Required: False ,
}
boolean ,
unixReadWrite:
{
Description: Read and write access ,
Required: False ,
}
boolean ,
cifs:
{
Description: Allows CIFS protocol ,
Required: False ,
}
boolean ,
nfsv3:
{
Description: Allows NFSv3 protocol ,
Required: False ,
}
boolean ,
nfsv4:
{
Description: Allows NFSv4 protocol ,
Required: False ,
}
boolean ,
allowedClients:
{
Description: Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names ,
Required: False ,
}
string ,
}
,
]
,
}
,
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
subnetId:
{
Description: The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
location:
{
Description: Resource location ,
Required: True ,
}
string ,
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
name:
{
Description: Resource name ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
properties:
{
Description: Volume properties ,
Required: True ,
}
{
fileSystemId:
{
Description: Unique FileSystem Identifier. ,
Required: False ,
}
string ,
creationToken:
{
Description: A unique file path for the volume. Used when creating mount targets ,
Required: True ,
}
string ,
serviceLevel:
{
Description: The service level of the file system ,
Enum:
{
Standard: Standard service level ,
Premium: Premium service level ,
Ultra: Ultra service level ,
}
,
Required: True ,
}
enum ,
usageThreshold:
{
Description: Maximum storage quota allowed for a file system in bytes. This is a soft quota used for alerting only. Minimum size is 100 GiB. Upper limit is 100TiB. ,
Format: int64 ,
Required: False ,
}
integer ,
exportPolicy:
{
Description: Export policy rule ,
Required: False ,
}
{
rules:
{
Required: False ,
}
[
{
ruleIndex:
{
Description: Order index ,
Required: False ,
}
integer ,
unixReadOnly:
{
Description: Read only access ,
Required: False ,
}
boolean ,
unixReadWrite:
{
Description: Read and write access ,
Required: False ,
}
boolean ,
cifs:
{
Description: Allows CIFS protocol ,
Required: False ,
}
boolean ,
nfsv3:
{
Description: Allows NFSv3 protocol ,
Required: False ,
}
boolean ,
nfsv4:
{
Description: Allows NFSv4 protocol ,
Required: False ,
}
boolean ,
allowedClients:
{
Description: Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names ,
Required: False ,
}
string ,
}
,
]
,
}
,
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
subnetId:
{
Description: The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: True ,
}
string ,
message:
{
Description: Detailed error message ,
Required: True ,
}
string ,
}
Volumes_Update (new)
Description :  Patch a volume
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}
{
body:
{
Description: Volume object supplied in the body of the operation. ,
Required: True ,
}
{
location:
{
Description: Resource location ,
Required: False ,
}
string ,
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
name:
{
Description: Resource name ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
properties:
{
Description: Patchable volume properties ,
Required: False ,
}
{
serviceLevel:
{
Description: The service level of the file system ,
Enum:
{
Standard: Standard service level ,
Premium: Premium service level ,
Ultra: Ultra service level ,
}
,
Required: False ,
}
enum ,
usageThreshold:
{
Description: Maximum storage quota allowed for a file system in bytes. This is a soft quota used for alerting only. Minimum size is 100 GiB. Upper limit is 100TiB. ,
Format: int64 ,
Required: False ,
}
integer ,
exportPolicy:
{
Description: Export policy rule ,
Required: False ,
}
{
rules:
{
Required: False ,
}
[
{
ruleIndex:
{
Description: Order index ,
Required: False ,
}
integer ,
unixReadOnly:
{
Description: Read only access ,
Required: False ,
}
boolean ,
unixReadWrite:
{
Description: Read and write access ,
Required: False ,
}
boolean ,
cifs:
{
Description: Allows CIFS protocol ,
Required: False ,
}
boolean ,
nfsv3:
{
Description: Allows NFSv3 protocol ,
Required: False ,
}
boolean ,
nfsv4:
{
Description: Allows NFSv4 protocol ,
Required: False ,
}
boolean ,
allowedClients:
{
Description: Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
}

⚐ Response (200)

{
location:
{
Description: Resource location ,
Required: True ,
}
string ,
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
name:
{
Description: Resource name ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
properties:
{
Description: Volume properties ,
Required: True ,
}
{
fileSystemId:
{
Description: Unique FileSystem Identifier. ,
Required: False ,
}
string ,
creationToken:
{
Description: A unique file path for the volume. Used when creating mount targets ,
Required: True ,
}
string ,
serviceLevel:
{
Description: The service level of the file system ,
Enum:
{
Standard: Standard service level ,
Premium: Premium service level ,
Ultra: Ultra service level ,
}
,
Required: True ,
}
enum ,
usageThreshold:
{
Description: Maximum storage quota allowed for a file system in bytes. This is a soft quota used for alerting only. Minimum size is 100 GiB. Upper limit is 100TiB. ,
Format: int64 ,
Required: False ,
}
integer ,
exportPolicy:
{
Description: Export policy rule ,
Required: False ,
}
{
rules:
{
Required: False ,
}
[
{
ruleIndex:
{
Description: Order index ,
Required: False ,
}
integer ,
unixReadOnly:
{
Description: Read only access ,
Required: False ,
}
boolean ,
unixReadWrite:
{
Description: Read and write access ,
Required: False ,
}
boolean ,
cifs:
{
Description: Allows CIFS protocol ,
Required: False ,
}
boolean ,
nfsv3:
{
Description: Allows NFSv3 protocol ,
Required: False ,
}
boolean ,
nfsv4:
{
Description: Allows NFSv4 protocol ,
Required: False ,
}
boolean ,
allowedClients:
{
Description: Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names ,
Required: False ,
}
string ,
}
,
]
,
}
,
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
subnetId:
{
Description: The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: True ,
}
string ,
message:
{
Description: Detailed error message ,
Required: True ,
}
string ,
}
Volumes_Delete (new)
Description :  Delete a volume
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}
{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: True ,
}
string ,
message:
{
Description: Detailed error message ,
Required: True ,
}
string ,
}
MountTargets_List (new)
Description :  List mount targets
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/mountTargets
{}

⚐ Response (200)

{
value:
{
Description: A list of Mount targets ,
Required: False ,
}
[
{
location:
{
Description: Resource location ,
Required: True ,
}
string ,
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
name:
{
Description: Resource name ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
properties:
{
Description: Mount Target Properties ,
Required: True ,
}
{
mountTargetId:
{
Description: UUID v4 used to identify the MountTarget ,
Required: False ,
}
string ,
fileSystemId:
{
Description: UUID v4 used to identify the MountTarget ,
Required: True ,
}
string ,
ipAddress:
{
Description: The mount target's IPv4 address ,
Required: False ,
}
string ,
subnet:
{
Description: The subnet ,
Required: False ,
}
string ,
startIp:
{
Description: The start of IPv4 address range to use when creating a new mount target ,
Required: False ,
}
string ,
endIp:
{
Description: The end of IPv4 address range to use when creating a new mount target ,
Required: False ,
}
string ,
gateway:
{
Description: The gateway of the IPv4 address range to use when creating a new mount target ,
Required: False ,
}
string ,
netmask:
{
Description: The netmask of the IPv4 address range to use when creating a new mount target ,
Required: False ,
}
string ,
smbServerFqdn:
{
Description: The SMB server's Fully Qualified Domain Name, FQDN ,
Required: False ,
}
string ,
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: True ,
}
string ,
message:
{
Description: Detailed error message ,
Required: True ,
}
string ,
}
Snapshots_List (new)
Description :  List snapshots
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/snapshots
{}

⚐ Response (200)

{
value:
{
Description: A list of Snapshots ,
Required: False ,
}
[
{
location:
{
Description: Resource location ,
Required: True ,
}
string ,
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
name:
{
Description: Resource name ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
properties:
{
Description: Snapshot Properties ,
Required: True ,
}
{
snapshotId:
{
Description: UUID v4 used to identify the Snapshot ,
Required: False ,
}
string ,
fileSystemId:
{
Description: UUID v4 used to identify the FileSystem ,
Required: True ,
}
string ,
creationDate:
{
Description: The creation date of the snapshot ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: True ,
}
string ,
message:
{
Description: Detailed error message ,
Required: True ,
}
string ,
}
Snapshots_Get (new)
Description :  Get a snapshot
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/snapshots/{snapshotName}
{}

⚐ Response (200)

{
location:
{
Description: Resource location ,
Required: True ,
}
string ,
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
name:
{
Description: Resource name ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
properties:
{
Description: Snapshot Properties ,
Required: True ,
}
{
snapshotId:
{
Description: UUID v4 used to identify the Snapshot ,
Required: False ,
}
string ,
fileSystemId:
{
Description: UUID v4 used to identify the FileSystem ,
Required: True ,
}
string ,
creationDate:
{
Description: The creation date of the snapshot ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: True ,
}
string ,
message:
{
Description: Detailed error message ,
Required: True ,
}
string ,
}
Snapshots_Create (new)
Description :  Create a snapshot
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/snapshots/{snapshotName}
{
body:
{
Description: Snapshot object supplied in the body of the operation. ,
Required: True ,
}
{
location:
{
Description: Resource location ,
Required: True ,
}
string ,
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
name:
{
Description: Resource name ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
properties:
{
Description: Snapshot Properties ,
Required: True ,
}
{
snapshotId:
{
Description: UUID v4 used to identify the Snapshot ,
Required: False ,
}
string ,
fileSystemId:
{
Description: UUID v4 used to identify the FileSystem ,
Required: True ,
}
string ,
creationDate:
{
Description: The creation date of the snapshot ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (201)

{
location:
{
Description: Resource location ,
Required: True ,
}
string ,
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
name:
{
Description: Resource name ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
properties:
{
Description: Snapshot Properties ,
Required: True ,
}
{
snapshotId:
{
Description: UUID v4 used to identify the Snapshot ,
Required: False ,
}
string ,
fileSystemId:
{
Description: UUID v4 used to identify the FileSystem ,
Required: True ,
}
string ,
creationDate:
{
Description: The creation date of the snapshot ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: True ,
}
string ,
message:
{
Description: Detailed error message ,
Required: True ,
}
string ,
}
Snapshots_Update (new)
Description :  Patch a snapshot
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/snapshots/{snapshotName}
{
body:
{
Description: Snapshot object supplied in the body of the operation. ,
Required: True ,
}
{
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
location:
{
Description: Resource location ,
Required: True ,
}
string ,
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
name:
{
Description: Resource name ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
properties:
{
Description: Snapshot Properties ,
Required: True ,
}
{
snapshotId:
{
Description: UUID v4 used to identify the Snapshot ,
Required: False ,
}
string ,
fileSystemId:
{
Description: UUID v4 used to identify the FileSystem ,
Required: True ,
}
string ,
creationDate:
{
Description: The creation date of the snapshot ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: True ,
}
string ,
message:
{
Description: Detailed error message ,
Required: True ,
}
string ,
}
Snapshots_Delete (new)
Description :  Delete snapshot
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/snapshots/{snapshotName}
{}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: True ,
}
string ,
message:
{
Description: Detailed error message ,
Required: True ,
}
string ,
}
Operations_List (removed)
Description :  Lists all of the available Microsoft.NetApp Rest API operations
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.NetApp/operations
{
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Storage operations supported by the Storage resource provider. ,
Required: False ,
}
[
{
name:
{
Description: Operation name: {provider}/{resource}/{operation} ,
Required: False ,
}
string ,
display:
{
Description: Display metadata associated with the operation. ,
Required: False ,
}
{
provider:
{
Description: Service provider: Microsoft NetApp. ,
Required: False ,
}
string ,
resource:
{
Description: Resource on which the operation is performed etc. ,
Required: False ,
}
string ,
operation:
{
Description: Type of operation: get, read, delete, etc. ,
Required: False ,
}
string ,
description:
{
Description: Operation description. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The origin of operations. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of operation, include metric specifications. ,
Required: False ,
}
{
serviceSpecification:
{
Description: One property of operation, include metric specifications. ,
Required: False ,
}
{
metricSpecifications:
{
Description: Metric specifications of operation. ,
Required: False ,
}
[
{
name:
{
Description: Name of metric specification. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of metric specification. ,
Required: False ,
}
string ,
displayDescription:
{
Description: Display description of metric specification. ,
Required: False ,
}
string ,
unit:
{
Description: Unit could be Bytes or Count. ,
Required: False ,
}
string ,
dimensions:
{
Description: Dimensions of blobs, including blob type and access tier. ,
Required: False ,
}
[
{
name:
{
Description: Display name of dimension. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of dimension. ,
Required: False ,
}
string ,
}
,
]
,
aggregationType:
{
Description: Aggregation type could be Average. ,
Required: False ,
}
string ,
fillGapWithZero:
{
Description: The property to decide fill gap with zero or not. ,
Required: False ,
}
boolean ,
category:
{
Description: The category this metric specification belong to, could be Capacity. ,
Required: False ,
}
string ,
resourceIdDimensionNameOverride:
{
Description: Account Resource Id. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
]
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: True ,
}
string ,
message:
{
Description: Detailed error message ,
Required: True ,
}
string ,
}
Accounts_List (removed)
Description :  Lists all NetApp accounts in the resource group
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts
{}

⚐ Response (200)

{
value:
{
Description: Multiple NetApp accounts ,
Required: False ,
}
[
{
location:
{
Description: Resource location ,
Required: True ,
}
string ,
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
name:
{
Description: Resource name ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
properties:
{
Description: NetApp Account properties ,
Required: True ,
}
{
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
activeDirectories:
{
Description: Active Directories ,
Required: False ,
}
[
{
activeDirectoryId:
{
Description: Id of the Active Directory ,
Required: False ,
}
string ,
username:
{
Description: Username of Active Directory domain administrator ,
Required: False ,
}
string ,
password:
{
Description: Plain text password of Active Directory domain administrator ,
Required: False ,
}
string ,
domain:
{
Description: Name of the Active Directory domain ,
Required: False ,
}
string ,
dNS:
{
Description: Comma separated list of DNS server IP addresses for the Active Directory domain ,
Required: False ,
}
string ,
status:
{
Description: Status of 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 ,
}
,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: True ,
}
string ,
message:
{
Description: Detailed error message ,
Required: True ,
}
string ,
}
Accounts_Get (removed)
Description :  Get the NetApp account
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}
{}

⚐ Response (200)

{
location:
{
Description: Resource location ,
Required: True ,
}
string ,
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
name:
{
Description: Resource name ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
properties:
{
Description: NetApp Account properties ,
Required: True ,
}
{
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
activeDirectories:
{
Description: Active Directories ,
Required: False ,
}
[
{
activeDirectoryId:
{
Description: Id of the Active Directory ,
Required: False ,
}
string ,
username:
{
Description: Username of Active Directory domain administrator ,
Required: False ,
}
string ,
password:
{
Description: Plain text password of Active Directory domain administrator ,
Required: False ,
}
string ,
domain:
{
Description: Name of the Active Directory domain ,
Required: False ,
}
string ,
dNS:
{
Description: Comma separated list of DNS server IP addresses for the Active Directory domain ,
Required: False ,
}
string ,
status:
{
Description: Status of 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 ,
}
,
]
,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: True ,
}
string ,
message:
{
Description: Detailed error message ,
Required: True ,
}
string ,
}
Accounts_CreateOrUpdate (removed)
Description :  Create or update a NetApp account
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}
{
body:
{
Description: NetApp Account object supplied in the body of the operation. ,
Required: True ,
}
{
location:
{
Description: Resource location ,
Required: True ,
}
string ,
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
name:
{
Description: Resource name ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
properties:
{
Description: NetApp Account properties ,
Required: True ,
}
{
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
activeDirectories:
{
Description: Active Directories ,
Required: False ,
}
[
{
activeDirectoryId:
{
Description: Id of the Active Directory ,
Required: False ,
}
string ,
username:
{
Description: Username of Active Directory domain administrator ,
Required: False ,
}
string ,
password:
{
Description: Plain text password of Active Directory domain administrator ,
Required: False ,
}
string ,
domain:
{
Description: Name of the Active Directory domain ,
Required: False ,
}
string ,
dNS:
{
Description: Comma separated list of DNS server IP addresses for the Active Directory domain ,
Required: False ,
}
string ,
status:
{
Description: Status of 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 ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
location:
{
Description: Resource location ,
Required: True ,
}
string ,
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
name:
{
Description: Resource name ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
properties:
{
Description: NetApp Account properties ,
Required: True ,
}
{
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
activeDirectories:
{
Description: Active Directories ,
Required: False ,
}
[
{
activeDirectoryId:
{
Description: Id of the Active Directory ,
Required: False ,
}
string ,
username:
{
Description: Username of Active Directory domain administrator ,
Required: False ,
}
string ,
password:
{
Description: Plain text password of Active Directory domain administrator ,
Required: False ,
}
string ,
domain:
{
Description: Name of the Active Directory domain ,
Required: False ,
}
string ,
dNS:
{
Description: Comma separated list of DNS server IP addresses for the Active Directory domain ,
Required: False ,
}
string ,
status:
{
Description: Status of 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 ,
}
,
]
,
}
,
}

⚐ Response (201)

{
location:
{
Description: Resource location ,
Required: True ,
}
string ,
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
name:
{
Description: Resource name ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
properties:
{
Description: NetApp Account properties ,
Required: True ,
}
{
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
activeDirectories:
{
Description: Active Directories ,
Required: False ,
}
[
{
activeDirectoryId:
{
Description: Id of the Active Directory ,
Required: False ,
}
string ,
username:
{
Description: Username of Active Directory domain administrator ,
Required: False ,
}
string ,
password:
{
Description: Plain text password of Active Directory domain administrator ,
Required: False ,
}
string ,
domain:
{
Description: Name of the Active Directory domain ,
Required: False ,
}
string ,
dNS:
{
Description: Comma separated list of DNS server IP addresses for the Active Directory domain ,
Required: False ,
}
string ,
status:
{
Description: Status of 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 ,
}
,
]
,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: True ,
}
string ,
message:
{
Description: Detailed error message ,
Required: True ,
}
string ,
}
Accounts_Delete (removed)
Description :  Delete a NetApp account
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}
{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: True ,
}
string ,
message:
{
Description: Detailed error message ,
Required: True ,
}
string ,
}
Accounts_Update (removed)
Description :  Patch a NetApp account
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}
{
body:
{
Description: NetApp Account object supplied in the body of the operation. ,
Required: True ,
}
{
location:
{
Description: Resource location ,
Required: False ,
}
string ,
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
name:
{
Description: Resource name ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
properties:
{
Description: NetApp Account properties ,
Required: False ,
}
{
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
activeDirectories:
{
Description: Active Directories ,
Required: False ,
}
[
{
activeDirectoryId:
{
Description: Id of the Active Directory ,
Required: False ,
}
string ,
username:
{
Description: Username of Active Directory domain administrator ,
Required: False ,
}
string ,
password:
{
Description: Plain text password of Active Directory domain administrator ,
Required: False ,
}
string ,
domain:
{
Description: Name of the Active Directory domain ,
Required: False ,
}
string ,
dNS:
{
Description: Comma separated list of DNS server IP addresses for the Active Directory domain ,
Required: False ,
}
string ,
status:
{
Description: Status of 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 ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
location:
{
Description: Resource location ,
Required: True ,
}
string ,
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
name:
{
Description: Resource name ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
properties:
{
Description: NetApp Account properties ,
Required: True ,
}
{
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
activeDirectories:
{
Description: Active Directories ,
Required: False ,
}
[
{
activeDirectoryId:
{
Description: Id of the Active Directory ,
Required: False ,
}
string ,
username:
{
Description: Username of Active Directory domain administrator ,
Required: False ,
}
string ,
password:
{
Description: Plain text password of Active Directory domain administrator ,
Required: False ,
}
string ,
domain:
{
Description: Name of the Active Directory domain ,
Required: False ,
}
string ,
dNS:
{
Description: Comma separated list of DNS server IP addresses for the Active Directory domain ,
Required: False ,
}
string ,
status:
{
Description: Status of 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 ,
}
,
]
,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: True ,
}
string ,
message:
{
Description: Detailed error message ,
Required: True ,
}
string ,
}
Pools_List (removed)
Description :  Lists all capacity pools in the NetApp Account
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools
{}

⚐ Response (200)

{
value:
{
Description: List of Capacity pools ,
Required: False ,
}
[
{
location:
{
Description: Resource location ,
Required: True ,
}
string ,
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
name:
{
Description: Resource name ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
properties:
{
Description: Capacity pool properties ,
Required: True ,
}
{
poolId:
{
Description: UUID v4 used to identify the Pool ,
Required: False ,
}
string ,
size:
{
Description: Provisioned size of the pool (in bytes). Allowed values are in 4TiB chunks (value must be multiply of 4398046511104). ,
Format: int64 ,
Required: False ,
}
integer ,
serviceLevel:
{
Description: The service level of the file system ,
Enum:
{
Standard: Standard service level ,
Premium: Premium service level ,
Ultra: Ultra service level ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: True ,
}
string ,
message:
{
Description: Detailed error message ,
Required: True ,
}
string ,
}
Pools_Get (removed)
Description :  Get a capacity pool
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}
{}

⚐ Response (200)

{
location:
{
Description: Resource location ,
Required: True ,
}
string ,
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
name:
{
Description: Resource name ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
properties:
{
Description: Capacity pool properties ,
Required: True ,
}
{
poolId:
{
Description: UUID v4 used to identify the Pool ,
Required: False ,
}
string ,
size:
{
Description: Provisioned size of the pool (in bytes). Allowed values are in 4TiB chunks (value must be multiply of 4398046511104). ,
Format: int64 ,
Required: False ,
}
integer ,
serviceLevel:
{
Description: The service level of the file system ,
Enum:
{
Standard: Standard service level ,
Premium: Premium service level ,
Ultra: Ultra service level ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: True ,
}
string ,
message:
{
Description: Detailed error message ,
Required: True ,
}
string ,
}
Pools_CreateOrUpdate (removed)
Description :  Create or Update a capacity pool
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}
{
body:
{
Description: Capacity pool object supplied in the body of the operation. ,
Required: True ,
}
{
location:
{
Description: Resource location ,
Required: True ,
}
string ,
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
name:
{
Description: Resource name ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
properties:
{
Description: Capacity pool properties ,
Required: True ,
}
{
poolId:
{
Description: UUID v4 used to identify the Pool ,
Required: False ,
}
string ,
size:
{
Description: Provisioned size of the pool (in bytes). Allowed values are in 4TiB chunks (value must be multiply of 4398046511104). ,
Format: int64 ,
Required: False ,
}
integer ,
serviceLevel:
{
Description: The service level of the file system ,
Enum:
{
Standard: Standard service level ,
Premium: Premium service level ,
Ultra: Ultra service level ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
location:
{
Description: Resource location ,
Required: True ,
}
string ,
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
name:
{
Description: Resource name ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
properties:
{
Description: Capacity pool properties ,
Required: True ,
}
{
poolId:
{
Description: UUID v4 used to identify the Pool ,
Required: False ,
}
string ,
size:
{
Description: Provisioned size of the pool (in bytes). Allowed values are in 4TiB chunks (value must be multiply of 4398046511104). ,
Format: int64 ,
Required: False ,
}
integer ,
serviceLevel:
{
Description: The service level of the file system ,
Enum:
{
Standard: Standard service level ,
Premium: Premium service level ,
Ultra: Ultra service level ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
location:
{
Description: Resource location ,
Required: True ,
}
string ,
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
name:
{
Description: Resource name ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
properties:
{
Description: Capacity pool properties ,
Required: True ,
}
{
poolId:
{
Description: UUID v4 used to identify the Pool ,
Required: False ,
}
string ,
size:
{
Description: Provisioned size of the pool (in bytes). Allowed values are in 4TiB chunks (value must be multiply of 4398046511104). ,
Format: int64 ,
Required: False ,
}
integer ,
serviceLevel:
{
Description: The service level of the file system ,
Enum:
{
Standard: Standard service level ,
Premium: Premium service level ,
Ultra: Ultra service level ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: True ,
}
string ,
message:
{
Description: Detailed error message ,
Required: True ,
}
string ,
}
Pools_Update (removed)
Description :  Patch a capacity pool
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}
{
body:
{
Description: Capacity pool object supplied in the body of the operation. ,
Required: True ,
}
{
location:
{
Description: Resource location ,
Required: False ,
}
string ,
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
name:
{
Description: Resource name ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
properties:
{
Description: Capacity pool properties ,
Required: False ,
}
{
size:
{
Description: Provisioned size of the pool (in bytes). Allowed values are in 4TiB chunks (value must be multiply of 4398046511104). ,
Format: int64 ,
Required: False ,
}
integer ,
serviceLevel:
{
Description: The service level of the file system ,
Enum:
{
Standard: Standard service level ,
Premium: Premium service level ,
Ultra: Ultra service level ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
location:
{
Description: Resource location ,
Required: True ,
}
string ,
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
name:
{
Description: Resource name ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
properties:
{
Description: Capacity pool properties ,
Required: True ,
}
{
poolId:
{
Description: UUID v4 used to identify the Pool ,
Required: False ,
}
string ,
size:
{
Description: Provisioned size of the pool (in bytes). Allowed values are in 4TiB chunks (value must be multiply of 4398046511104). ,
Format: int64 ,
Required: False ,
}
integer ,
serviceLevel:
{
Description: The service level of the file system ,
Enum:
{
Standard: Standard service level ,
Premium: Premium service level ,
Ultra: Ultra service level ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: True ,
}
string ,
message:
{
Description: Detailed error message ,
Required: True ,
}
string ,
}
Pools_Delete (removed)
Description :  Delete a capacity pool
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}
{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: True ,
}
string ,
message:
{
Description: Detailed error message ,
Required: True ,
}
string ,
}
Volumes_List (removed)
Description :  List volumes
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes
{}

⚐ Response (200)

{
value:
{
Description: List of volumes ,
Required: False ,
}
[
{
location:
{
Description: Resource location ,
Required: True ,
}
string ,
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
name:
{
Description: Resource name ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
properties:
{
Description: Volume properties ,
Required: True ,
}
{
fileSystemId:
{
Description: Unique FileSystem Identifier. ,
Required: False ,
}
string ,
creationToken:
{
Description: A unique file path for the volume. Used when creating mount targets ,
Required: True ,
}
string ,
serviceLevel:
{
Description: The service level of the file system ,
Enum:
{
Standard: Standard service level ,
Premium: Premium service level ,
Ultra: Ultra service level ,
}
,
Required: True ,
}
enum ,
usageThreshold:
{
Description: Maximum storage quota allowed for a file system in bytes. This is a soft quota used for alerting only. Minimum size is 100 GiB. Upper limit is 100TiB. ,
Format: int64 ,
Required: False ,
}
integer ,
exportPolicy:
{
Description: Export policy rule ,
Required: False ,
}
{
rules:
{
Required: False ,
}
[
{
ruleIndex:
{
Description: Order index ,
Required: False ,
}
integer ,
unixReadOnly:
{
Description: Read only access ,
Required: False ,
}
boolean ,
unixReadWrite:
{
Description: Read and write access ,
Required: False ,
}
boolean ,
cifs:
{
Description: Allows CIFS protocol ,
Required: False ,
}
boolean ,
nfsv3:
{
Description: Allows NFSv3 protocol ,
Required: False ,
}
boolean ,
nfsv4:
{
Description: Allows NFSv4 protocol ,
Required: False ,
}
boolean ,
allowedClients:
{
Description: Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names ,
Required: False ,
}
string ,
}
,
]
,
}
,
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
subnetId:
{
Description: The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: True ,
}
string ,
message:
{
Description: Detailed error message ,
Required: True ,
}
string ,
}
Volumes_Get (removed)
Description :  Get a volume
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}
{}

⚐ Response (200)

{
location:
{
Description: Resource location ,
Required: True ,
}
string ,
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
name:
{
Description: Resource name ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
properties:
{
Description: Volume properties ,
Required: True ,
}
{
fileSystemId:
{
Description: Unique FileSystem Identifier. ,
Required: False ,
}
string ,
creationToken:
{
Description: A unique file path for the volume. Used when creating mount targets ,
Required: True ,
}
string ,
serviceLevel:
{
Description: The service level of the file system ,
Enum:
{
Standard: Standard service level ,
Premium: Premium service level ,
Ultra: Ultra service level ,
}
,
Required: True ,
}
enum ,
usageThreshold:
{
Description: Maximum storage quota allowed for a file system in bytes. This is a soft quota used for alerting only. Minimum size is 100 GiB. Upper limit is 100TiB. ,
Format: int64 ,
Required: False ,
}
integer ,
exportPolicy:
{
Description: Export policy rule ,
Required: False ,
}
{
rules:
{
Required: False ,
}
[
{
ruleIndex:
{
Description: Order index ,
Required: False ,
}
integer ,
unixReadOnly:
{
Description: Read only access ,
Required: False ,
}
boolean ,
unixReadWrite:
{
Description: Read and write access ,
Required: False ,
}
boolean ,
cifs:
{
Description: Allows CIFS protocol ,
Required: False ,
}
boolean ,
nfsv3:
{
Description: Allows NFSv3 protocol ,
Required: False ,
}
boolean ,
nfsv4:
{
Description: Allows NFSv4 protocol ,
Required: False ,
}
boolean ,
allowedClients:
{
Description: Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names ,
Required: False ,
}
string ,
}
,
]
,
}
,
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
subnetId:
{
Description: The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: True ,
}
string ,
message:
{
Description: Detailed error message ,
Required: True ,
}
string ,
}
Volumes_CreateOrUpdate (removed)
Description :  Create or update a volume
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}
{
body:
{
Description: Volume object supplied in the body of the operation. ,
Required: True ,
}
{
location:
{
Description: Resource location ,
Required: True ,
}
string ,
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
name:
{
Description: Resource name ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
properties:
{
Description: Volume properties ,
Required: True ,
}
{
fileSystemId:
{
Description: Unique FileSystem Identifier. ,
Required: False ,
}
string ,
creationToken:
{
Description: A unique file path for the volume. Used when creating mount targets ,
Required: True ,
}
string ,
serviceLevel:
{
Description: The service level of the file system ,
Enum:
{
Standard: Standard service level ,
Premium: Premium service level ,
Ultra: Ultra service level ,
}
,
Required: True ,
}
enum ,
usageThreshold:
{
Description: Maximum storage quota allowed for a file system in bytes. This is a soft quota used for alerting only. Minimum size is 100 GiB. Upper limit is 100TiB. ,
Format: int64 ,
Required: False ,
}
integer ,
exportPolicy:
{
Description: Export policy rule ,
Required: False ,
}
{
rules:
{
Required: False ,
}
[
{
ruleIndex:
{
Description: Order index ,
Required: False ,
}
integer ,
unixReadOnly:
{
Description: Read only access ,
Required: False ,
}
boolean ,
unixReadWrite:
{
Description: Read and write access ,
Required: False ,
}
boolean ,
cifs:
{
Description: Allows CIFS protocol ,
Required: False ,
}
boolean ,
nfsv3:
{
Description: Allows NFSv3 protocol ,
Required: False ,
}
boolean ,
nfsv4:
{
Description: Allows NFSv4 protocol ,
Required: False ,
}
boolean ,
allowedClients:
{
Description: Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names ,
Required: False ,
}
string ,
}
,
]
,
}
,
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
subnetId:
{
Description: The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
location:
{
Description: Resource location ,
Required: True ,
}
string ,
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
name:
{
Description: Resource name ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
properties:
{
Description: Volume properties ,
Required: True ,
}
{
fileSystemId:
{
Description: Unique FileSystem Identifier. ,
Required: False ,
}
string ,
creationToken:
{
Description: A unique file path for the volume. Used when creating mount targets ,
Required: True ,
}
string ,
serviceLevel:
{
Description: The service level of the file system ,
Enum:
{
Standard: Standard service level ,
Premium: Premium service level ,
Ultra: Ultra service level ,
}
,
Required: True ,
}
enum ,
usageThreshold:
{
Description: Maximum storage quota allowed for a file system in bytes. This is a soft quota used for alerting only. Minimum size is 100 GiB. Upper limit is 100TiB. ,
Format: int64 ,
Required: False ,
}
integer ,
exportPolicy:
{
Description: Export policy rule ,
Required: False ,
}
{
rules:
{
Required: False ,
}
[
{
ruleIndex:
{
Description: Order index ,
Required: False ,
}
integer ,
unixReadOnly:
{
Description: Read only access ,
Required: False ,
}
boolean ,
unixReadWrite:
{
Description: Read and write access ,
Required: False ,
}
boolean ,
cifs:
{
Description: Allows CIFS protocol ,
Required: False ,
}
boolean ,
nfsv3:
{
Description: Allows NFSv3 protocol ,
Required: False ,
}
boolean ,
nfsv4:
{
Description: Allows NFSv4 protocol ,
Required: False ,
}
boolean ,
allowedClients:
{
Description: Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names ,
Required: False ,
}
string ,
}
,
]
,
}
,
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
subnetId:
{
Description: The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
location:
{
Description: Resource location ,
Required: True ,
}
string ,
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
name:
{
Description: Resource name ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
properties:
{
Description: Volume properties ,
Required: True ,
}
{
fileSystemId:
{
Description: Unique FileSystem Identifier. ,
Required: False ,
}
string ,
creationToken:
{
Description: A unique file path for the volume. Used when creating mount targets ,
Required: True ,
}
string ,
serviceLevel:
{
Description: The service level of the file system ,
Enum:
{
Standard: Standard service level ,
Premium: Premium service level ,
Ultra: Ultra service level ,
}
,
Required: True ,
}
enum ,
usageThreshold:
{
Description: Maximum storage quota allowed for a file system in bytes. This is a soft quota used for alerting only. Minimum size is 100 GiB. Upper limit is 100TiB. ,
Format: int64 ,
Required: False ,
}
integer ,
exportPolicy:
{
Description: Export policy rule ,
Required: False ,
}
{
rules:
{
Required: False ,
}
[
{
ruleIndex:
{
Description: Order index ,
Required: False ,
}
integer ,
unixReadOnly:
{
Description: Read only access ,
Required: False ,
}
boolean ,
unixReadWrite:
{
Description: Read and write access ,
Required: False ,
}
boolean ,
cifs:
{
Description: Allows CIFS protocol ,
Required: False ,
}
boolean ,
nfsv3:
{
Description: Allows NFSv3 protocol ,
Required: False ,
}
boolean ,
nfsv4:
{
Description: Allows NFSv4 protocol ,
Required: False ,
}
boolean ,
allowedClients:
{
Description: Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names ,
Required: False ,
}
string ,
}
,
]
,
}
,
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
subnetId:
{
Description: The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: True ,
}
string ,
message:
{
Description: Detailed error message ,
Required: True ,
}
string ,
}
Volumes_Update (removed)
Description :  Patch a volume
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}
{
body:
{
Description: Volume object supplied in the body of the operation. ,
Required: True ,
}
{
location:
{
Description: Resource location ,
Required: False ,
}
string ,
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
name:
{
Description: Resource name ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
properties:
{
Description: Patchable volume properties ,
Required: False ,
}
{
serviceLevel:
{
Description: The service level of the file system ,
Enum:
{
Standard: Standard service level ,
Premium: Premium service level ,
Ultra: Ultra service level ,
}
,
Required: False ,
}
enum ,
usageThreshold:
{
Description: Maximum storage quota allowed for a file system in bytes. This is a soft quota used for alerting only. Minimum size is 100 GiB. Upper limit is 100TiB. ,
Format: int64 ,
Required: False ,
}
integer ,
exportPolicy:
{
Description: Export policy rule ,
Required: False ,
}
{
rules:
{
Required: False ,
}
[
{
ruleIndex:
{
Description: Order index ,
Required: False ,
}
integer ,
unixReadOnly:
{
Description: Read only access ,
Required: False ,
}
boolean ,
unixReadWrite:
{
Description: Read and write access ,
Required: False ,
}
boolean ,
cifs:
{
Description: Allows CIFS protocol ,
Required: False ,
}
boolean ,
nfsv3:
{
Description: Allows NFSv3 protocol ,
Required: False ,
}
boolean ,
nfsv4:
{
Description: Allows NFSv4 protocol ,
Required: False ,
}
boolean ,
allowedClients:
{
Description: Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
}

⚐ Response (200)

{
location:
{
Description: Resource location ,
Required: True ,
}
string ,
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
name:
{
Description: Resource name ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
properties:
{
Description: Volume properties ,
Required: True ,
}
{
fileSystemId:
{
Description: Unique FileSystem Identifier. ,
Required: False ,
}
string ,
creationToken:
{
Description: A unique file path for the volume. Used when creating mount targets ,
Required: True ,
}
string ,
serviceLevel:
{
Description: The service level of the file system ,
Enum:
{
Standard: Standard service level ,
Premium: Premium service level ,
Ultra: Ultra service level ,
}
,
Required: True ,
}
enum ,
usageThreshold:
{
Description: Maximum storage quota allowed for a file system in bytes. This is a soft quota used for alerting only. Minimum size is 100 GiB. Upper limit is 100TiB. ,
Format: int64 ,
Required: False ,
}
integer ,
exportPolicy:
{
Description: Export policy rule ,
Required: False ,
}
{
rules:
{
Required: False ,
}
[
{
ruleIndex:
{
Description: Order index ,
Required: False ,
}
integer ,
unixReadOnly:
{
Description: Read only access ,
Required: False ,
}
boolean ,
unixReadWrite:
{
Description: Read and write access ,
Required: False ,
}
boolean ,
cifs:
{
Description: Allows CIFS protocol ,
Required: False ,
}
boolean ,
nfsv3:
{
Description: Allows NFSv3 protocol ,
Required: False ,
}
boolean ,
nfsv4:
{
Description: Allows NFSv4 protocol ,
Required: False ,
}
boolean ,
allowedClients:
{
Description: Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names ,
Required: False ,
}
string ,
}
,
]
,
}
,
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
subnetId:
{
Description: The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: True ,
}
string ,
message:
{
Description: Detailed error message ,
Required: True ,
}
string ,
}
Volumes_Delete (removed)
Description :  Delete a volume
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}
{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: True ,
}
string ,
message:
{
Description: Detailed error message ,
Required: True ,
}
string ,
}
MountTargets_List (removed)
Description :  List mount targets
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/mountTargets
{}

⚐ Response (200)

{
value:
{
Description: A list of Mount targets ,
Required: False ,
}
[
{
location:
{
Description: Resource location ,
Required: True ,
}
string ,
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
name:
{
Description: Resource name ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
properties:
{
Description: Mount Target Properties ,
Required: True ,
}
{
mountTargetId:
{
Description: UUID v4 used to identify the MountTarget ,
Required: False ,
}
string ,
fileSystemId:
{
Description: UUID v4 used to identify the MountTarget ,
Required: True ,
}
string ,
ipAddress:
{
Description: The mount target's IPv4 address ,
Required: False ,
}
string ,
subnet:
{
Description: The subnet ,
Required: False ,
}
string ,
startIp:
{
Description: The start of IPv4 address range to use when creating a new mount target ,
Required: False ,
}
string ,
endIp:
{
Description: The end of IPv4 address range to use when creating a new mount target ,
Required: False ,
}
string ,
gateway:
{
Description: The gateway of the IPv4 address range to use when creating a new mount target ,
Required: False ,
}
string ,
netmask:
{
Description: The netmask of the IPv4 address range to use when creating a new mount target ,
Required: False ,
}
string ,
smbServerFqdn:
{
Description: The SMB server's Fully Qualified Domain Name, FQDN ,
Required: False ,
}
string ,
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: True ,
}
string ,
message:
{
Description: Detailed error message ,
Required: True ,
}
string ,
}
Snapshots_List (removed)
Description :  List snapshots
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/snapshots
{}

⚐ Response (200)

{
value:
{
Description: A list of Snapshots ,
Required: False ,
}
[
{
location:
{
Description: Resource location ,
Required: True ,
}
string ,
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
name:
{
Description: Resource name ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
properties:
{
Description: Snapshot Properties ,
Required: True ,
}
{
snapshotId:
{
Description: UUID v4 used to identify the Snapshot ,
Required: False ,
}
string ,
fileSystemId:
{
Description: UUID v4 used to identify the FileSystem ,
Required: True ,
}
string ,
creationDate:
{
Description: The creation date of the snapshot ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: True ,
}
string ,
message:
{
Description: Detailed error message ,
Required: True ,
}
string ,
}
Snapshots_Get (removed)
Description :  Get a snapshot
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/snapshots/{snapshotName}
{}

⚐ Response (200)

{
location:
{
Description: Resource location ,
Required: True ,
}
string ,
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
name:
{
Description: Resource name ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
properties:
{
Description: Snapshot Properties ,
Required: True ,
}
{
snapshotId:
{
Description: UUID v4 used to identify the Snapshot ,
Required: False ,
}
string ,
fileSystemId:
{
Description: UUID v4 used to identify the FileSystem ,
Required: True ,
}
string ,
creationDate:
{
Description: The creation date of the snapshot ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: True ,
}
string ,
message:
{
Description: Detailed error message ,
Required: True ,
}
string ,
}
Snapshots_Create (removed)
Description :  Create a snapshot
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/snapshots/{snapshotName}
{
body:
{
Description: Snapshot object supplied in the body of the operation. ,
Required: True ,
}
{
location:
{
Description: Resource location ,
Required: True ,
}
string ,
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
name:
{
Description: Resource name ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
properties:
{
Description: Snapshot Properties ,
Required: True ,
}
{
snapshotId:
{
Description: UUID v4 used to identify the Snapshot ,
Required: False ,
}
string ,
fileSystemId:
{
Description: UUID v4 used to identify the FileSystem ,
Required: True ,
}
string ,
creationDate:
{
Description: The creation date of the snapshot ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (201)

{
location:
{
Description: Resource location ,
Required: True ,
}
string ,
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
name:
{
Description: Resource name ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
properties:
{
Description: Snapshot Properties ,
Required: True ,
}
{
snapshotId:
{
Description: UUID v4 used to identify the Snapshot ,
Required: False ,
}
string ,
fileSystemId:
{
Description: UUID v4 used to identify the FileSystem ,
Required: True ,
}
string ,
creationDate:
{
Description: The creation date of the snapshot ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: True ,
}
string ,
message:
{
Description: Detailed error message ,
Required: True ,
}
string ,
}
Snapshots_Update (removed)
Description :  Patch a snapshot
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/snapshots/{snapshotName}
{
body:
{
Description: Snapshot object supplied in the body of the operation. ,
Required: True ,
}
{
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
location:
{
Description: Resource location ,
Required: True ,
}
string ,
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
name:
{
Description: Resource name ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
properties:
{
Description: Snapshot Properties ,
Required: True ,
}
{
snapshotId:
{
Description: UUID v4 used to identify the Snapshot ,
Required: False ,
}
string ,
fileSystemId:
{
Description: UUID v4 used to identify the FileSystem ,
Required: True ,
}
string ,
creationDate:
{
Description: The creation date of the snapshot ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: True ,
}
string ,
message:
{
Description: Detailed error message ,
Required: True ,
}
string ,
}
Snapshots_Delete (removed)
Description :  Delete snapshot
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/snapshots/{snapshotName}
{}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: True ,
}
string ,
message:
{
Description: Detailed error message ,
Required: True ,
}
string ,
}