Azure.ResourceManager.NetApp.Models Namespace

Classes

Name Description
ActiveDirectoryConfigProperties

Active Directory Configuration properties.

ArmNetAppModelFactory

Model factory for models.

AvailabilityZoneMapping

Availability zone mapping.

BackupsMigrationContent

Migrate Backups Request.

BindPasswordKeyVaultConfig

The Azure Key Vault configuration where the Bind DN (Distinguished Name) user password is stored.

BindPasswordKeyVaultConfigPatch

The Azure Key Vault configuration where the Bind DN (Distinguished Name) user password is stored.

CapacityPoolPatch

Capacity pool patch resource.

CertificateKeyVaultDetails

Specifies the Azure Key Vault settings for retrieving the bucket server certificate.

ChangeZoneContent

Changes the zone for the Zone Redundant elastic capacity pool.

CheckElasticResourceAvailabilityResult

Information regarding availability of a resource.

CheckElasticVolumeFilePathAvailabilityContent

File path availability request content - availability is based on the elastic volume filePath within the given elastic capacityPool.

ClusterPeerCommandResponseProperties

Properties of the cluster peer command response.

ClusterPeerCommandResult

Information about cluster peering process.

CredentialsKeyVaultDetails

Specifies the Azure Key Vault settings for storing the bucket credentials.

ElasticAccountProperties

NetApp elastic account properties.

ElasticBackupPolicyProperties

Elastic Backup Policy properties.

ElasticBackupProperties

Elastic Backup properties.

ElasticCapacityPoolProperties

Elastic capacity pool properties.

ElasticEncryption

Encryption settings.

ElasticEncryptionConfiguration

CMK Encryption Configuration.

ElasticEncryptionIdentity

Identity used to authenticate with key vault.

ElasticExportPolicyRule

Elastic Volume Export Policy Rule.

ElasticKeyVaultProperties

Properties of key vault.

ElasticMountTargetProperties

Contains all the information needed to mount an elastic volume.

ElasticSnapshotPolicyDailySchedule

Daily Schedule properties used to create NetApp snapshot policy.

ElasticSnapshotPolicyHourlySchedule

Hourly Schedule properties used to create NetApp snapshot policy.

ElasticSnapshotPolicyMonthlySchedule

Monthly Schedule properties used to create NetApp snapshot policy.

ElasticSnapshotPolicyProperties

Elastic Snapshot policy properties.

ElasticSnapshotPolicyWeeklySchedule

Weekly Schedule properties used to create NetApp snapshot policy.

ElasticVolumeBackupProperties

Elastic Volume Backup Properties.

ElasticVolumeDataProtectionPatchProperties

Data protection configuration option for updating the volume, including snapshot policies and backup.

ElasticVolumeDataProtectionProperties

Data protection configuration option for the volume, including snapshot policies and backup.

ElasticVolumeProperties

Elastic Volume properties.

ElasticVolumeRevert

Reverts the elastic volume to the specified snapshot.

EntraIdAkvConfig

Entra ID Azure Key Vault configuration.

EntraIdAkvConfigPatch

Entra ID Azure Key Vault configuration patch.

EntraIdConfig

Entra ID configuration.

EntraIdConfigPatch

Entra ID configuration patch.

GetGroupIdListForLdapUserContent

Get group Id list for LDAP User request.

GetGroupIdListForLdapUserResult

Group Id list for Ldap user.

LdapConfiguration

LDAP configuration.

LdapConfigurationPatch

LDAP configuration for PATCH operations (no default values).

ListQuotaReportResult
  • Result of ListQuotaReportResponse.
ListReplicationsContent

Body for the list replications endpoint. If supplied, the body will be used as a filter for example to exclude deleted replications. If omitted, the endpoint returns all replications.

NetAppAccountActiveDirectory

Active Directory.

NetAppAccountEncryption

Encryption settings.

NetAppAccountPatch

NetApp account patch resource.

NetAppActiveDirectoryConfigPatch

The type used for update operations of the ActiveDirectoryConfig.

NetAppActiveDirectoryConfigPatchProperties

The updatable properties of the ActiveDirectoryConfig.

NetAppBackupPolicyPatch

Backup policy Details for create and update.

NetAppBackupVaultBackupPatch

Backup patch.

NetAppBackupVaultPatch

Backup Vault information.

NetAppBucketCredentialsExpiry

The bucket's Access and Secret key pair Expiry Time expressed as the number of days from now.

NetAppBucketGenerateCredentials

Bucket Access Key, Secret Key, and Expiry date and time of the key pair.

NetAppBucketPatch

Bucket resource.

NetAppBucketServerPatchProperties

Properties of the server managing the lifecycle of volume buckets.

NetAppBucketServerProperties

Properties of the server managing the lifecycle of volume buckets.

NetAppCacheMountTargetProperties

Contains all the information needed to mount a cache.

NetAppCachePatch

The type used for update operations of the Cache.

NetAppCachePatchProperties

The updatable properties of the Cache.

NetAppCacheProperties

Cache resource properties.

NetAppChangeKeyVault

Change key vault request.

NetAppCheckAvailabilityResult

Information regarding availability of a resource.

NetAppDestinationReplication

Destination replication properties.

NetAppElasticAccountPatch

The type used for update operations of the ElasticAccount.

NetAppElasticBackupPolicyPatch

The type used for update operations of the ElasticBackupPolicy.

NetAppElasticBackupPolicyPatchProperties

The updatable properties of the ElasticBackupPolicy.

NetAppElasticBackupVaultPatch

The type used for update operations of the ElasticBackupVault.

NetAppElasticCapacityPoolPatch

The type used for update operations of the ElasticCapacityPool.

NetAppElasticCapacityPoolPatchProperties

The updatable properties of the ElasticCapacityPool.

NetAppElasticSnapshotPolicyPatch

The type used for update operations of the ElasticSnapshotPolicy.

NetAppElasticSnapshotPolicyPatchProperties

The updatable properties of the ElasticSnapshotPolicy.

NetAppElasticVolumePatch

The type used for update operations of the ElasticVolume.

NetAppElasticVolumePatchProperties

The updatable properties of the ElasticVolume.

NetAppEncryptionIdentity

Identity used to authenticate with key vault.

NetAppEncryptionTransitionContent

Encryption transition request.

NetAppFilePathAvailabilityContent

File path availability request content - availability is based on the name and the subnetId.

NetAppFileSystemUser

File System user having access to volume data. For Unix, this is the user's uid and gid. For Windows, this is the user's username. Note that the Unix and Windows user details are mutually exclusive, meaning one or other must be supplied, but not both.

NetAppKeyVaultDetails

Specifies the Azure Key Vault settings. These are used when a) retrieving the bucket server certificate, and b) storing the bucket credentials Notes:

  1. If a bucket certificate was previously provided directly using the certificateObject property, it is possible to subsequently use the Azure Key Vault for certificate management by using these 'akvDetails' properties. However, once Azure Key Vault is configured, it is no longer possible to provide the certificate directly via the certificateObject property.
  1. These properties are mutually exclusive with the server.certificateObject property.
NetAppKeyVaultPrivateEndpoint

Pairs of virtual network ID and private endpoint ID. Every virtual network that has volumes encrypted with customer-managed keys needs its own key vault private endpoint.

NetAppKeyVaultProperties

Properties of key vault.

NetAppKeyVaultStatusResult

Result of getKeyVaultStatus with information about how volumes under NetApp account are encrypted.

NetAppLdapSearchScopeConfiguration

LDAP search scope.

NetAppNameAvailabilityContent

Resource name availability request content.

NetAppNfsUser

The effective NFS User ID and Group ID when accessing the volume data.

NetAppOriginClusterInformation

Stores the origin cluster information associated to a cache.

NetAppPeeringPassphrases

The response containing peering passphrases and commands for cluster and vserver peering.

NetAppQuotaAvailabilityContent

Quota availability request content.

NetAppRegionInfo

Provides region specific information.

NetAppReplicationObject

Replication properties.

NetAppRestoreStatus

Restore status.

NetAppSecretPassword

Access password from Azure KeyVault Secrets to connect Active Directory.

NetAppSecretPasswordIdentity

Identity used to authenticate with key vault.

NetAppSecretPasswordKeyVaultPatchProperties

Properties of key vault to get the secrets for password.

NetAppSmbSettings

SMB settings for the cache.

NetAppSubscriptionQuotaItem

Information regarding Quota Item.

NetAppSubvolumeInfoPatch

Subvolume Patch Request properties.

NetAppSubvolumeMetadata

Result of the post subvolume and action is to get metadata of the subvolume.

NetAppUsageName

The name of the usage.

NetAppUsageResult

Usages entity model.

NetAppVolumeAuthorizeReplicationContent

Authorize request.

NetAppVolumeBackupBackupRestoreFilesContent

Restore payload for Single File Backup Restore.

NetAppVolumeBackupConfiguration

Volume Backup Properties.

NetAppVolumeBackupDetail

Volume details using the backup policy.

NetAppVolumeBackupStatus

Backup status.

NetAppVolumeBreakFileLocksContent

Break file locks request.

NetAppVolumeBreakReplicationContent

Break replication request.

NetAppVolumeDataProtection

DataProtection type volumes include an object containing details of the replication.

NetAppVolumeExportPolicyRule

Volume Export Policy Rule.

NetAppVolumeGroupMetadata

Volume group properties.

NetAppVolumeGroupResult

Volume group resource.

NetAppVolumeGroupVolume

Volume resource.

NetAppVolumeMountTarget

Mount target properties.

NetAppVolumePatch

Volume patch resource.

NetAppVolumePatchDataProtection

DataProtection type volumes include an object containing details of the replication.

NetAppVolumePlacementRule

Application specific parameters for the placement of volumes in the volume group.

NetAppVolumePoolChangeContent

Pool change request.

NetAppVolumeQuotaReport

Quota report record properties.

NetAppVolumeQuotaRulePatch

Patchable Quota Rule of a Volume.

NetAppVolumeReestablishReplicationContent

Re-establish request object supplied in the body of the operation.

NetAppVolumeRelocationProperties

Volume relocation properties.

NetAppVolumeReplication

Replication properties.

NetAppVolumeReplicationStatus

Replication status.

NetAppVolumeRevertContent

revert a volume to the snapshot.

NetAppVolumeSnapshotPatch

Snapshot of a Volume.

NetAppVolumeSnapshotRestoreFilesContent

Restore payload for Single File Snapshot Restore.

NetworkSiblingSet

Describes the contents of a network sibling set.

NicInfo

NIC information and list of volumes for which the NIC has the primary mount IP Address.

PeerClusterForVolumeMigrationContent

Source Cluster properties for a cluster peer request.

QueryNetworkSiblingSetContent

Network sibling set query.

QuotaReportFilterContent

Quota report filters. When filtering by quotaType or quotaTarget, both properties must be supplied together. This constraint is enforced by the service/API at runtime, and requests violating this rule will return a validation error. The usageThresholdPercentage filter is independent and can be used alone or in combination with quotaType and quotaTarget to further refine results.

RansomwareProtectionSettings

Advanced Ransomware Protection reports (ARP) settings.

RansomwareReportProperties

Ransomware report properties.

RansomwareSuspects

List of suspects identified in an Advanced Ransomware Protection (ARP) report.

RansomwareSuspectsClearContent

Clear suspects for Advanced Ransomware Protection (ARP) report.

RelocateVolumeContent

Relocate volume request.

RemotePath

The full path to a volume that is to be migrated into ANF. Required for Migration volumes.

SnapshotPolicyDailySchedule

Daily Schedule properties.

SnapshotPolicyHourlySchedule

Hourly Schedule properties.

SnapshotPolicyMonthlySchedule

Monthly Schedule properties.

SnapshotPolicyPatch

Snapshot policy Details for create and update.

SnapshotPolicyWeeklySchedule

Weekly Schedule properties, make a snapshot every week at a specific day or days.

SuspectFile

Suspect file information.

SvmPeerCommandResult

Information about svm peering process.

UpdateNetworkSiblingSetContent

Network sibling set update.

Structs

Name Description
AcceptGrowCapacityPoolForShortTermCloneSplit

While auto splitting the short term clone volume, if the parent pool does not have enough space to accommodate the volume after split, it will be automatically resized, which will lead to increased billing. To accept capacity pool size auto grow and create a short term clone volume, set the property as accepted.

ActualRansomwareProtectionState

The actual state of the Advanced Ransomware Protection feature.

BindAuthenticationLevel

The authentication level to use when binding to the LDAP server.

BreakthroughMode

Breakthrough mode.

CapacityPoolEncryptionType

Encryption type of the capacity pool, set encryption type for data at rest for this pool and all volumes in it. This value can only be set when creating new pool.

CapacityPoolQosType

The qos type of the pool.

CheckElasticResourceAvailabilityReason

Availability reason.

CheckElasticResourceAvailabilityStatus

Availability status.

CoolAccessRetrievalPolicy

coolAccessRetrievalPolicy determines the data retrieval behavior from the cool tier to standard storage based on the read pattern for cool access enabled volumes. The possible values for this field are: Default - Data will be pulled from cool tier to standard storage on random reads. This policy is the default. OnRead - All client-driven data read is pulled from cool tier to standard storage on both sequential and random reads. Never - No client-driven data is pulled from cool tier to standard storage.

CoolAccessTieringPolicy

coolAccessTieringPolicy determines which cold data blocks are moved to cool tier. The possible values for this field are: Auto - Moves cold user data blocks in both the Snapshot copies and the active file system to the cool tier tier. This policy is the default. SnapshotOnly - Moves user data blocks of the Volume Snapshot copies that are not associated with the active file system to the cool tier.

DayOfWeek

Day of the week.

DesiredRansomwareProtectionState

The desired state of the Advanced Ransomware Protection feature.

ElasticBackupPolicyState

Elastic Backup Policy state.

ElasticBackupSnapshotUsage

Snapshot usage for backup.

ElasticBackupType

Type of backup.

ElasticBackupVolumeSize

Volume size for backup.

ElasticKeyVaultStatus

KeyVault status.

ElasticNfsv3Access

NFSv3 access.

ElasticNfsv4Access

NFSv4 access.

ElasticPoolEncryptionKeySource

Pool Encryption Key Source.

ElasticProtocolType

Protocol types for elastic volume.

ElasticResourceAvailabilityStatus

Current availability status of the resource.

ElasticRootAccess

Root access.

ElasticServiceLevel

Service level for elastic capacity pool.

ElasticSmbEncryption

SMB encryption.

ElasticSnapshotPolicyStatus

Policy status.

ElasticUnixAccessRule

Unix access rule.

ElasticVolumePolicyEnforcement

Policy enforcement.

ElasticVolumeRestorationState

The current state of the restoration process.

EnableNetAppSubvolume

Flag indicating whether subvolume operations are enabled on the volume.

ExcludeReplicationsFilter

An option to filter out replications. 'None' returns all replications, 'Deleted' excludes deleted replications. Default is 'None'.

LargeVolumeType

Large volume type.

MultiAdStatus

MultiAD Status for the account.

NetAppAccountActiveDirectoryStatus

Status of the Active Directory.

NetAppApplicationType

Application Type.

NetAppAvsDataStore

Specifies whether the volume is enabled for Azure VMware Solution (AVS) datastore purpose.

NetAppBackupType

Type of backup Manual or Scheduled.

NetAppBucketPatchPermission

Access permissions for the bucket. Either ReadOnly or ReadWrite.

NetAppBucketPermission

Access permissions for the bucket. Either ReadOnly or ReadWrite. The default is ReadOnly if no value is provided during bucket creation.

NetAppCacheFileAccessLogs

Flag indicating whether file access logs are enabled for the Cache, based on active diagnostic settings present on the Cache.

NetAppCacheLifeCycleState

Azure NetApp Files Cache lifecycle management.

NetAppCacheProvisioningState

Azure lifecycle management.

NetAppChownMode

This parameter specifies who is authorized to change the ownership of a file. restricted - Only root user can change the ownership of the file. unrestricted - Non-root users can change ownership of files that they own.

NetAppCifsChangeNotifyState

Flag indicating whether a CIFS change notification is enabled for the cache.

NetAppCredentialsStatus

The bucket credentials status. There states: "NoCredentialsSet": Access and Secret key pair have not been generated. "CredentialsExpired": Access and Secret key pair have expired. "Active": The certificate has been installed and credentials are unexpired.

NetAppEnableWriteBackState

Flag indicating whether writeback is enabled for the cache.

NetAppEncryptionKeySource

Source of key used to encrypt data in volume. Applicable if NetApp account has encryption.keySource = 'Microsoft.KeyVault'. Possible values (case-insensitive) are: 'Microsoft.NetApp, Microsoft.KeyVault'.

NetAppEncryptionState

Specifies if the cache is encryption or not.

NetAppEndpointType

Indicates whether the local volume is the source or destination for the Volume Replication.

NetAppExternalReplicationSetupStatus

Property that only applies to external replications. Provides a machine-readable value for the status of the external replication setup.

NetAppFileAccessLog

Flag indicating whether file access logs are enabled for the volume, based on active diagnostic settings present on the volume.

NetAppFileServiceLevel

The service level of the file system.

NetAppGlobalFileLockingState

Flag indicating whether the global file lock is enabled for the cache.

NetAppKerberosState

Describe if a cache is Kerberos enabled.

NetAppKeySource

The encryption keySource (provider). Possible values (case-insensitive): Microsoft.NetApp, Microsoft.KeyVault.

NetAppKeyVaultStatus

Status of the KeyVault connection.

NetAppLdapServerType

The type of the LDAP server.

NetAppLdapState

Specifies whether LDAP is enabled or not.

NetAppMirrorState

The status of the replication.

NetAppNameAvailabilityResourceType

Resource type used for verification.

NetAppNameUnavailableReason

<code>Invalid</code> indicates the name provided does not match Azure App Service naming requirements. <code>AlreadyExists</code> indicates that the name is already in use and is therefore unavailable.

NetAppNetworkFeature

Network features available to the volume, or current state of update.

NetAppOnCertificateConflictAction

This action is triggered when a certificate conflict occurs. A conflict arises if you try to create a new bucket while one or more already exist on the server, or if you update a bucket when multiple buckets are present. This happens because a single certificate is shared among all buckets on the same server. Note: This applies both to certificates provided directly via the certificateObject property and to those retrieved from Azure Key Vault. Details for the latter case are specified in the akvDetails.certificateAkvDetails section.

NetAppProtocolType

Set of supported protocol types, which include NFSv3, NFSv4 and SMB protocol.

NetAppProvisioningState

Gets the status of the VolumeQuotaRule at the time the operation was called.

NetAppQuotaAvailabilityResourceType

Resource type used for verification.

NetAppRelationshipStatus

Status of the mirror relationship.

NetAppReplicationSchedule

Schedule.

NetAppReplicationType

Indicates whether the replication is cross zone or cross region.

NetAppSmbEncryptionState

Enables encryption for in-flight smb3 data. Only applicable for SMB/DualProtocol cache.

NetAppVolumeLanguage

Language supported for volume.

NetAppVolumeQuotaRuleProvisioningState

Compatibility alias for NetApp volume quota rule provisioning state values.

NetAppVolumeQuotaType

Type of quota.

NetAppVolumeSecurityStyle

The security style of volume, default unix, defaults to ntfs for dual protocol or CIFS protocol.

NetAppVolumeStorageToNetworkProximity

Provides storage to network proximity information for the volume.

NetworkSiblingSetProvisioningState

Gets the status of the NetworkSiblingSet at the time the operation was called.

RansomwareReportSeverity

Severity of the Advanced Ransomware Protection (ARP) report.

RansomwareReportState

State of the Advanced Ransomware Protection (ARP) report.

RansomwareSuspectResolution

ARP report suspect resolution.

RegionStorageToNetworkProximity

Provides storage to network proximity information in the region.

ReplicationMirrorState

The status of the replication.

SmbAccessBasedEnumeration

Enables access-based enumeration share property for SMB Shares. Only applicable for SMB/DualProtocol volume.

SmbNonBrowsable

Enables non-browsable property for SMB Shares. Only applicable for SMB/DualProtocol volume.

SnapshotDirectoryVisibility

Controls the visibility of the Elastic Volume's read-only snapshot directory, which provides access to each of the volume's snapshots.

VolumeBackupRelationshipStatus

Status of the volume backup relationship.

VolumeReplicationRelationshipStatus

Status of the volume replication relationship.

VolumeRestoreRelationshipStatus

Status of the volume restore relationship.