Az.NetAppFiles Module
The topics in this section document the Azure PowerShell cmdlets for Azure NetApp Files in the Azure Resource Manager (ARM) framework. The cmdlets exist in the Microsoft.Azure.Commands.NetAppFiles namespace.
NetApp Files
| Cmdlet | Description |
|---|---|
| Approve-AzNetAppFilesReplication |
Approve/Authorize replication connection on the source volume |
| Clear-AzNetAppFilesRansomwareReportSuspect |
Clears suspects for an Azure NetApp Files (ANF) Advanced Ransomware Protection (ARP) report. |
| Convert-AzNetAppFilesAccountToCmk |
Transition volumes encryption from PMK to CMK. |
| Get-AzNetAppFilesAccount |
Gets details of an Azure NetApp Files (ANF) account. |
| Get-AzNetAppFilesAccountKeyVaultStatus |
Get information about how volumes under NetApp account are encrypted |
| Get-AzNetAppFilesActiveDirectory |
Gets details of an Azure NetApp Files (ANF) Active Directory configuration. |
| Get-AzNetAppFilesBackup |
Gets details of an Azure NetApp Files (ANF) Backup. |
| Get-AzNetAppFilesBackupPolicy |
Gets details of an Azure NetApp Files (ANF) Backup Policy. |
| Get-AzNetAppFilesBackupVault |
Gets details of an Azure NetApp Files (ANF) BackupVault. |
| Get-AzNetAppFilesBucket |
Get the details of the specified volume's bucket. A bucket allows additional services, such as AI services, connect to the volume data contained in those buckets. |
| Get-AzNetAppFilesCache |
Gets details of an Azure NetApp Files (ANF) Cache or lists all Caches in a Capacity Pool. |
| Get-AzNetAppFilesCachePeeringPassphrase |
Gets the cluster-peering and vserver-peering commands and passphrases required to complete peering between an Azure NetApp Files (ANF) Cache and its on-prem ONTAP origin. |
| Get-AzNetAppFilesFilePathAvailability |
Check file path availability |
| Get-AzNetAppFilesNameAvailability |
Check resource name availability |
| Get-AzNetAppFilesNetworkSiblingSet |
Get details of a network sibling set |
| Get-AzNetAppFilesPool |
Gets details of an Azure NetApp Files (ANF) pool. |
| Get-AzNetAppFilesQuotaAvailability |
Check quota availability |
| Get-AzNetAppFilesQuotaLimit |
Get quota limits |
| Get-AzNetAppFilesRansomwareReport |
Gets details of an Azure NetApp Files (ANF) Advanced Ransomware Protection (ARP) report. |
| Get-AzNetAppFilesRegionInfo |
Describes region specific information |
| Get-AzNetAppFilesReplicationStatus |
Get the status of the replication |
| Get-AzNetAppFilesSnapshot |
Gets details of an Azure NetApp Files (ANF) snapshot. |
| Get-AzNetAppFilesSnapshotPolicy |
Gets details of an Azure NetApp Files (ANF) snapshot policy. |
| Get-AzNetAppFilesSnapshotPolicyVolumeList |
Get Volumes for Azure NetApp Files (ANF) Snapshot Policy |
| Get-AzNetAppFilesSubvolume |
Gets details of an Azure NetApp Files (ANF) subvolume. |
| Get-AzNetAppFilesSubvolumeMetadata |
Gets metadata details of an Azure NetApp Files (ANF) subvolume. |
| Get-AzNetAppFilesUsage |
Get usages |
| Get-AzNetAppFilesVolume |
Gets details of an Azure NetApp Files (ANF) volume. |
| Get-AzNetAppFilesVolumeBackupStatus |
Get volume's backup status |
| Get-AzNetAppFilesVolumeGroup |
Gets details of an Azure NetApp Files (ANF) VolumeGroup. |
| Get-AzNetAppFilesVolumeGroupIdListForLDAPUser |
Get Group Id List for LDAP User |
| Get-AzNetAppFilesVolumeQuotaReport |
Gets a quota report for an Azure NetApp Files (ANF) volume. |
| Get-AzNetAppFilesVolumeQuotaRule |
Gets details of an Azure NetApp Files (ANF) Volume Quota Rule. |
| Get-AzNetAppFilesVolumeReplication |
Get volume's replication |
| Get-AzNetAppFilesVolumeRestoreStatus |
Get volume's restore status |
| Initialize-AzNetAppFilesReplication |
Re-Initializes the replication connection on the destination volume |
| Invoke-AzNetAppFilesAccountChangeKeyVault |
Change Key Vault/Managed HSM that is used for encryption of volumes under NetApp account |
| New-AzNetAppFilesAccount |
Creates a new Azure NetApp Files (ANF) account. |
| New-AzNetAppFilesActiveDirectory |
Creates a new Azure NetApp Files (ANF) active directory configuration. |
| New-AzNetAppFilesBackup |
Creates a new Azure NetApp Files (ANF) backup. |
| New-AzNetAppFilesBackupPolicy |
Creates a new Azure NetApp Files (ANF) backup policy for an ANF account. |
| New-AzNetAppFilesBackupVault |
Creates a new Azure NetApp Files (ANF) BackupVault. |
| New-AzNetAppFilesBucket |
Creates a new Bucket on an Azure NetApp Files (ANF) Volume. |
| New-AzNetAppFilesBucketCredential |
Generates a new Access Key / Secret Key pair for an Azure NetApp Files (ANF) Bucket and returns the credentials in cleartext. |
| New-AzNetAppFilesCache |
Creates a new Azure NetApp Files (ANF) Cache (FlexCache) in a Capacity Pool. |
| New-AzNetAppFilesExportPolicyObject |
Creates export policy object. |
| New-AzNetAppFilesExportPolicyRuleObject |
Creates export policy rule object. |
| New-AzNetAppFilesPool |
Creates a new Azure NetApp Files (ANF) pool. |
| New-AzNetAppFilesSnapshot |
Creates a new Azure NetApp Files (ANF) snapshot. |
| New-AzNetAppFilesSnapshotPolicy |
Creates a new Azure NetApp Files (ANF) snapshot policy for an ANF account. |
| New-AzNetAppFilesSubvolume |
Creates a new Azure NetApp Files (ANF) subvolume. |
| New-AzNetAppFilesVolume |
Creates a new Azure NetApp Files (ANF) volume. |
| New-AzNetAppFilesVolumeGroup |
Creates a new Azure NetApp Files (ANF) VolumeGroup along with requisite volumes. Creating volume group will create all the volumes specified in request body implicitly. Once volumes are created using volume group, those will be treated as regular volumes thereafter. |
| New-AzNetAppFilesVolumeQuotaRule |
Creates a new Azure NetApp Files (ANF) Volume Quota Rule. |
| Remove-AzNetAppFilesAccount |
Deletes an Azure NetApp Files (ANF) account. |
| Remove-AzNetAppFilesActiveDirectory |
Deletes an Azure NetApp Files (ANF) active directory configuration. |
| Remove-AzNetAppFilesBackup |
Deletes an Azure NetApp Files (ANF) backup. |
| Remove-AzNetAppFilesBackupPolicy |
Deletes an Azure NetApp Files (ANF) backup policy. |
| Remove-AzNetAppFilesBackupVault |
Deletes an Azure NetApp Files (ANF) BackupVault. |
| Remove-AzNetAppFilesBucket |
Deletes an Azure NetApp Files (ANF) Bucket. |
| Remove-AzNetAppFilesCache |
Deletes an Azure NetApp Files (ANF) Cache. |
| Remove-AzNetAppFilesPool |
Deletes an Azure NetApp Files (ANF) pool. |
| Remove-AzNetAppFilesReplication |
Remove/Delete the replication connection on the destination volume, and send release to the source replication |
| Remove-AzNetAppFilesSnapshot |
Deletes an Azure NetApp Files (ANF) snapshot. |
| Remove-AzNetAppFilesSnapshotPolicy |
Deletes an Azure NetApp Files (ANF) snapshot policy. |
| Remove-AzNetAppFilesSubvolume |
Deletes an Azure NetApp Files (ANF) subvolume. |
| Remove-AzNetAppFilesVolume |
Deletes an Azure NetApp Files (ANF) volume. |
| Remove-AzNetAppFilesVolumeGroup |
Deletes an Azure NetApp Files (ANF) VolumeGroup. This delete the specified volume group only does not delete the volumes. |
| Remove-AzNetAppFilesVolumeQuotaRule |
Deletes an Azure NetApp Files (ANF) Volume Quota Rule. |
| Reset-AzNetAppFilesCacheSmbPassword |
Resets the SMB machine account password on an Azure NetApp Files (ANF) Cache. |
| Reset-AzNetAppFilesVolumeCifsPassword |
Reset the Cifs password for the volume |
| Restore-AzNetAppFilesBackupFile |
Create a new Backup Restore Files request |
| Restore-AzNetAppFilesReplication |
Restore (Re-establish) the specified replication for the volume |
| Restore-AzNetAppFilesSnapshotFile |
Restore the specified files from the specified snapshot to the active filesystem |
| Restore-AzNetAppFilesVolume |
Restore/Revert a volume to one of its snapshots |
| Resume-AzNetAppFilesReplication |
Resume/Resync the connection on the destination volume. If the operation is ran on the source volume it will reverse-resync the connection and sync from source to destination. |
| Set-AzNetAppFilesAccount |
Updates an Azure NetApp Files (ANF) account with the new data set. Useful for deletion of associated active directories. |
| Set-AzNetAppFilesBackupPolicy |
Updates an Azure NetApp Files (ANF) Backup Policy with the new data set. |
| Set-AzNetAppFilesBackupVault |
Updates an Azure NetApp Files (ANF) BackupVault with the new data set. |
| Set-AzNetAppFilesBucketAkvCredential |
Generates an Azure NetApp Files (ANF) Bucket Access Key / Secret Key pair and stores it in Azure Key Vault. |
| Set-AzNetAppFilesCachePool |
Moves an Azure NetApp Files (ANF) Cache to a different Capacity Pool. |
| Set-AzNetAppFilesPool |
Updates an Azure NetApp Files (ANF) Capacity Pool with the new data set. |
| Set-AzNetAppFilesSnapshotPolicy |
Updates an Azure NetApp Files (ANF) Snapshot Policy with the new data set. |
| Set-AzNetAppFilesVolumePool |
Change pool for an Azure NetApp Files (ANF) volume. |
| Split-AzNetAppFilesCloneFromParent |
Split clone from parent volume |
| Start-AzNetAppFilesAuthorizeExternalReplication |
Start migration process |
| Start-AzNetAppFilesFinalizeExternalReplication |
Finalize migration process |
| Start-AzNetAppFilesPeerExternalCluster |
Start Cluster peering |
| Start-AzNetAppFilesPerformExternalReplication |
Perform a replication transfer |
| Suspend-AzNetAppFilesReplication |
Suspend/break the replication connection on the destination volume |
| Unlock-AzNetAppFilesVolumeFileLock |
Break file locks |
| Update-AzNetAppFilesAccount |
Updates an Azure NetApp Files (ANF) account according to the optional modifiers provided. |
| Update-AzNetAppFilesAccountCredential |
Renew identity credentials |
| Update-AzNetAppFilesActiveDirectory |
Updates an Azure NetApp Files (ANF) active directory configuration to the optional modifiers provided. |
| Update-AzNetAppFilesBackup |
Updates an Azure NetApp Files (ANF) backup to the optional modifiers provided. |
| Update-AzNetAppFilesBackupPolicy |
Updates an Azure NetApp Files (ANF) backup policy to the optional modifiers provided. |
| Update-AzNetAppFilesBackupVault |
Updates an Azure NetApp Files (ANF) BackupVault according to the optional modifiers provided. |
| Update-AzNetAppFilesBucket |
Updates an existing Azure NetApp Files (ANF) Bucket. |
| Update-AzNetAppFilesBucketCertificate |
Refreshes an Azure NetApp Files (ANF) Bucket server certificate from Azure Key Vault. |
| Update-AzNetAppFilesCache |
Updates an existing Azure NetApp Files (ANF) Cache. |
| Update-AzNetAppFilesNetworkSiblingSet |
Update the network features of a network sibling set |
| Update-AzNetAppFilesPool |
Updates an Azure NetApp Files (ANF) pool according to the optional modifiers provided. |
| Update-AzNetAppFilesSnapshotPolicy |
Updates an Azure NetApp Files (ANF) snapshot policy to the optional modifiers provided. |
| Update-AzNetAppFilesSubvolume |
Updates an Azure NetApp Files (ANF) subvolume according to the optional modifiers provided. |
| Update-AzNetAppFilesVolume |
Updates an Azure NetApp Files (ANF) volume according to the optional modifiers provided. |
| Update-AzNetAppFilesVolumeQuotaRule |
Updates an Azure NetApp Files (ANF) volume quota rule according to the optional modifiers provided. |
