Snapshots - Create

Create a snapshot
Create the specified snapshot within the given volume

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/snapshots/{snapshotName}?api-version=2024-07-01

URI Parameters

Name In Required Type Description
accountName
path True

string

The name of the NetApp account

Regex pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-_]{0,127}$

poolName
path True

string

The name of the capacity pool

Regex pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-_]{0,63}$

resourceGroupName
path True

string

The name of the resource group. The name is case insensitive.

snapshotName
path True

string

The name of the snapshot

subscriptionId
path True

string

uuid

The ID of the target subscription. The value must be an UUID.

volumeName
path True

string

The name of the volume

Regex pattern: ^[a-zA-Z][a-zA-Z0-9\-_]{0,63}$

api-version
query True

string

The API version to use for this operation.

Request Body

Name Required Type Description
location True

string

Resource location

Responses

Name Type Description
201 Created

snapshot

Snapshot created

202 Accepted

Accepted -- Create request accepted; operation will complete asynchronously

Other Status Codes

ErrorResponse

Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

Snapshots_Create

Sample request

PUT https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1/snapshots/snapshot1?api-version=2024-07-01

{
  "location": "eastus"
}

Sample response

{
  "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1/snapshots/snapshot1",
  "name": "account1/pool1/volume1/snapshot1",
  "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots",
  "location": "eastus",
  "properties": {
    "snapshotId": "9760acf5-4638-11e7-9bdb-020073ca3333",
    "created": "2017-08-15T13:23:33Z",
    "provisioningState": "Succeeded"
  }
}

Definitions

Name Description
createdByType

The type of identity that created the resource.

ErrorAdditionalInfo

The resource management error additional info.

ErrorDetail

The error detail.

ErrorResponse

Error response

snapshot

Snapshot of a Volume

systemData

Metadata pertaining to creation and last modification of the resource.

createdByType

The type of identity that created the resource.

Name Type Description
Application

string

Key

string

ManagedIdentity

string

User

string

ErrorAdditionalInfo

The resource management error additional info.

Name Type Description
info

object

The additional info.

type

string

The additional info type.

ErrorDetail

The error detail.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

The error additional info.

code

string

The error code.

details

ErrorDetail[]

The error details.

message

string

The error message.

target

string

The error target.

ErrorResponse

Error response

Name Type Description
error

ErrorDetail

The error object.

snapshot

Snapshot of a Volume

Name Type Description
id

string

Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

location

string

Resource location

name

string

The name of the resource

properties.created

string

name
The creation date of the snapshot

properties.provisioningState

string

Azure lifecycle management

properties.snapshotId

string

snapshotId
UUID v4 used to identify the Snapshot

systemData

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

type

string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

systemData

Metadata pertaining to creation and last modification of the resource.

Name Type Description
createdAt

string

The timestamp of resource creation (UTC).

createdBy

string

The identity that created the resource.

createdByType

createdByType

The type of identity that created the resource.

lastModifiedAt

string

The timestamp of resource last modification (UTC)

lastModifiedBy

string

The identity that last modified the resource.

lastModifiedByType

createdByType

The type of identity that last modified the resource.