Package-level declarations

Types

Link copied to clipboard
data class AccountEncryptionResponse(val identity: EncryptionIdentityResponse? = null, val keySource: String? = null, val keyVaultProperties: KeyVaultPropertiesResponse? = null)

Encryption settings

Link copied to clipboard
data class ActiveDirectoryResponse(val activeDirectoryId: String? = null, val adName: String? = null, val administrators: List<String>? = null, val aesEncryption: Boolean? = null, val allowLocalNfsUsersWithLdap: Boolean? = null, val backupOperators: List<String>? = null, val dns: String? = null, val domain: String? = null, val encryptDCConnections: Boolean? = null, val kdcIP: String? = null, val ldapOverTLS: Boolean? = null, val ldapSearchScope: LdapSearchScopeOptResponse? = null, val ldapSigning: Boolean? = null, val organizationalUnit: String? = null, val password: String? = null, val preferredServersForLdapClient: String? = null, val securityOperators: List<String>? = null, val serverRootCACertificate: String? = null, val site: String? = null, val smbServerName: String? = null, val status: String, val statusDetails: String, val username: String? = null)

Active Directory

Link copied to clipboard
data class BucketServerPropertiesResponse(val certificateCommonName: String, val certificateExpiryDate: String, val fqdn: String? = null, val ipAddress: String)

Properties of the server managing the lifecycle of volume buckets

Link copied to clipboard
data class CifsUserResponse(val username: String? = null)

The effective CIFS username when accessing the volume data.

Link copied to clipboard
data class DailyScheduleResponse(val hour: Int? = null, val minute: Int? = null, val snapshotsToKeep: Int? = null, val usedBytes: Double? = null)

Daily Schedule properties

Link copied to clipboard
data class EncryptionIdentityResponse(val principalId: String, val userAssignedIdentity: String? = null)

Identity used to authenticate with key vault.

Link copied to clipboard
data class ExportPolicyRuleResponse(val allowedClients: String? = null, val chownMode: String? = null, val cifs: Boolean? = null, val hasRootAccess: Boolean? = null, val kerberos5ReadOnly: Boolean? = null, val kerberos5ReadWrite: Boolean? = null, val kerberos5iReadOnly: Boolean? = null, val kerberos5iReadWrite: Boolean? = null, val kerberos5pReadOnly: Boolean? = null, val kerberos5pReadWrite: Boolean? = null, val nfsv3: Boolean? = null, val nfsv41: Boolean? = null, val ruleIndex: Int? = null, val unixReadOnly: Boolean? = null, val unixReadWrite: Boolean? = null)

Volume Export Policy Rule

Link copied to clipboard
data class FileSystemUserResponse(val cifsUser: CifsUserResponse? = null, val nfsUser: NfsUserResponse? = null)

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.

data class GetAccountChangeKeyVaultInformationResult(val keyName: String? = null, val keyVaultPrivateEndpoints: List<KeyVaultPrivateEndpointResponse>? = null, val keyVaultResourceId: String? = null, val keyVaultUri: String? = null)

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

Link copied to clipboard
data class GetAccountKeyVaultStatusResult(val keyName: String? = null, val keyVaultPrivateEndpoints: List<KeyVaultPrivateEndpointResponse>? = null, val keyVaultResourceId: String? = null, val keyVaultUri: String? = null)

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

Link copied to clipboard
data class GetAccountResult(val activeDirectories: List<ActiveDirectoryResponse>? = null, val azureApiVersion: String, val disableShowmount: Boolean, val encryption: AccountEncryptionResponse? = null, val etag: String, val id: String, val identity: ManagedServiceIdentityResponse? = null, val location: String, val name: String, val provisioningState: String, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

NetApp account resource

Link copied to clipboard
data class GetBackupPolicyResult(val azureApiVersion: String, val backupPolicyId: String, val dailyBackupsToKeep: Int? = null, val enabled: Boolean? = null, val etag: String, val id: String, val location: String, val monthlyBackupsToKeep: Int? = null, val name: String, val provisioningState: String, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String, val volumeBackups: List<VolumeBackupsResponse>, val volumesAssigned: Int, val weeklyBackupsToKeep: Int? = null)

Backup policy information

Link copied to clipboard
data class GetBackupResult(val azureApiVersion: String, val backupId: String, val backupPolicyResourceId: String, val backupType: String, val creationDate: String, val failureReason: String, val id: String, val label: String? = null, val name: String, val provisioningState: String, val size: Double, val snapshotName: String? = null, val systemData: SystemDataResponse, val type: String, val useExistingSnapshot: Boolean? = null, val volumeResourceId: String)

Backup under a Backup Vault

Link copied to clipboard
data class GetBackupVaultResult(val azureApiVersion: String, val id: String, val location: String, val name: String, val provisioningState: String, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

Backup Vault information

Link copied to clipboard
data class GetCapacityPoolBackupResult(val azureApiVersion: String, val backupId: String, val backupType: String, val creationDate: String, val failureReason: String, val id: String, val label: String? = null, val location: String, val name: String, val provisioningState: String, val size: Double, val systemData: SystemDataResponse, val type: String, val useExistingSnapshot: Boolean? = null, val volumeName: String)

Backup of a Volume

Link copied to clipboard
data class GetCapacityPoolBucketResult(val azureApiVersion: String, val fileSystemUser: FileSystemUserResponse? = null, val id: String, val name: String, val path: String? = null, val provisioningState: String, val server: BucketServerPropertiesResponse? = null, val status: String, val systemData: SystemDataResponse, val type: String)

Bucket resource

Link copied to clipboard
data class GetCapacityPoolResult(val azureApiVersion: String, val coolAccess: Boolean? = null, val encryptionType: String? = null, val etag: String, val id: String, val location: String, val name: String, val poolId: String, val provisioningState: String, val qosType: String? = null, val serviceLevel: String, val size: Double, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val totalThroughputMibps: Double, val type: String, val utilizedThroughputMibps: Double)

Capacity pool resource

Link copied to clipboard
data class GetCapacityPoolSnapshotResult(val azureApiVersion: String, val created: String, val id: String, val location: String, val name: String, val provisioningState: String, val snapshotId: String, val systemData: SystemDataResponse, val type: String)

Snapshot of a Volume

Link copied to clipboard
data class GetCapacityPoolSubvolumeMetadataResult(val accessedTimeStamp: String? = null, val bytesUsed: Double? = null, val changedTimeStamp: String? = null, val creationTimeStamp: String? = null, val id: String, val modifiedTimeStamp: String? = null, val name: String, val parentPath: String? = null, val path: String? = null, val permissions: String? = null, val provisioningState: String? = null, val size: Double? = null, val type: String)

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

Link copied to clipboard
data class GetCapacityPoolSubvolumeResult(val azureApiVersion: String, val id: String, val name: String, val parentPath: String? = null, val path: String? = null, val provisioningState: String, val size: Double? = null, val systemData: SystemDataResponse, val type: String)

Subvolume Information properties

data class GetCapacityPoolVolumeGroupIdForLdapUserResult(val groupIdsForLdapUser: List<String>? = null)

Group Id list for Ldap user

Link copied to clipboard
data class GetCapacityPoolVolumeQuotaRuleResult(val azureApiVersion: String, val id: String, val location: String, val name: String, val provisioningState: String, val quotaSizeInKiBs: Double? = null, val quotaTarget: String? = null, val quotaType: String? = null, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

Quota Rule of a Volume

Link copied to clipboard
data class GetCapacityPoolVolumeResult(val actualThroughputMibps: Double, val avsDataStore: String? = null, val azureApiVersion: String, val backupId: String? = null, val baremetalTenantId: String, val capacityPoolResourceId: String? = null, val cloneProgress: Int, val coolAccess: Boolean? = null, val coolAccessRetrievalPolicy: String? = null, val coolAccessTieringPolicy: String? = null, val coolnessPeriod: Int? = null, val creationToken: String, val dataProtection: VolumePropertiesResponseDataProtection? = null, val dataStoreResourceId: List<String>, val defaultGroupQuotaInKiBs: Double? = null, val defaultUserQuotaInKiBs: Double? = null, val deleteBaseSnapshot: Boolean? = null, val effectiveNetworkFeatures: String, val enableSubvolumes: String? = null, val encrypted: Boolean, val encryptionKeySource: String? = null, val etag: String, val exportPolicy: VolumePropertiesResponseExportPolicy? = null, val fileAccessLogs: String, val fileSystemId: String, val id: String, val isDefaultQuotaEnabled: Boolean? = null, val isLargeVolume: Boolean? = null, val isRestoring: Boolean? = null, val kerberosEnabled: Boolean? = null, val keyVaultPrivateEndpointResourceId: String? = null, val ldapEnabled: Boolean? = null, val location: String, val maximumNumberOfFiles: Double, val mountTargets: List<MountTargetPropertiesResponse>, val name: String, val networkFeatures: String? = null, val networkSiblingSetId: String, val originatingResourceId: String, val placementRules: List<PlacementKeyValuePairsResponse>? = null, val protocolTypes: List<String>? = null, val provisionedAvailabilityZone: String, val provisioningState: String, val proximityPlacementGroup: String? = null, val securityStyle: String? = null, val serviceLevel: String? = null, val smbAccessBasedEnumeration: String? = null, val smbContinuouslyAvailable: Boolean? = null, val smbEncryption: Boolean? = null, val smbNonBrowsable: String? = null, val snapshotDirectoryVisible: Boolean? = null, val snapshotId: String? = null, val storageToNetworkProximity: String, val subnetId: String, val systemData: SystemDataResponse, val t2Network: String, val tags: Map<String, String>? = null, val throughputMibps: Double? = null, val type: String, val unixPermissions: String? = null, val usageThreshold: Double, val volumeGroupName: String, val volumeSpecName: String? = null, val volumeType: String? = null, val zones: List<String>? = null)

Volume resource

Link copied to clipboard
data class GetSnapshotPolicyResult(val azureApiVersion: String, val dailySchedule: DailyScheduleResponse? = null, val enabled: Boolean? = null, val etag: String, val hourlySchedule: HourlyScheduleResponse? = null, val id: String, val location: String, val monthlySchedule: MonthlyScheduleResponse? = null, val name: String, val provisioningState: String, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String, val weeklySchedule: WeeklyScheduleResponse? = null)

Snapshot policy information

Link copied to clipboard
data class GetVolumeGroupResult(val azureApiVersion: String, val groupMetaData: VolumeGroupMetaDataResponse? = null, val id: String, val location: String? = null, val name: String, val provisioningState: String, val type: String, val volumes: List<VolumeGroupVolumePropertiesResponse>? = null)

Volume group resource for create

Link copied to clipboard
data class HourlyScheduleResponse(val minute: Int? = null, val snapshotsToKeep: Int? = null, val usedBytes: Double? = null)

Hourly Schedule properties

Link copied to clipboard
data class KeyVaultPrivateEndpointResponse(val privateEndpointId: String? = null, val virtualNetworkId: String? = null)

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.

Link copied to clipboard
data class KeyVaultPropertiesResponse(val keyName: String, val keyVaultId: String, val keyVaultResourceId: String? = null, val keyVaultUri: String, val status: String)

Properties of key vault.

Link copied to clipboard
data class LdapSearchScopeOptResponse(val groupDN: String? = null, val groupMembershipFilter: String? = null, val userDN: String? = null)

LDAP search scope

Link copied to clipboard
data class ListCapacityPoolVolumeQuotaReportResult(val nextLink: String? = null, val value: List<QuotaReportResponse>? = null)

Quota Report for volume

Link copied to clipboard

List Replications

Link copied to clipboard
data class ManagedServiceIdentityResponse(val principalId: String, val tenantId: String, val type: String, val userAssignedIdentities: Map<String, UserAssignedIdentityResponse>? = null)

Managed service identity (system assigned and/or user assigned identities)

Link copied to clipboard
data class MonthlyScheduleResponse(val daysOfMonth: String? = null, val hour: Int? = null, val minute: Int? = null, val snapshotsToKeep: Int? = null, val usedBytes: Double? = null)

Monthly Schedule properties

Link copied to clipboard
data class MountTargetPropertiesResponse(val fileSystemId: String, val ipAddress: String, val mountTargetId: String, val smbServerFqdn: String? = null)

Mount target properties

Link copied to clipboard
data class NfsUserResponse(val groupId: Double? = null, val userId: Double? = null)

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

Link copied to clipboard
data class PlacementKeyValuePairsResponse(val key: String, val value: String)

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

Link copied to clipboard
data class QuotaReportResponse(val isDerivedQuota: Boolean? = null, val percentageUsed: Double? = null, val quotaLimitTotalInKiBs: Double? = null, val quotaLimitUsedInKiBs: Double? = null, val quotaTarget: String? = null, val quotaType: String? = null)

Quota report record properties

Link copied to clipboard
data class RemotePathResponse(val externalHostName: String, val serverName: String, val volumeName: String)

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

Link copied to clipboard
data class ReplicationObjectResponse(val endpointType: String? = null, val remotePath: RemotePathResponse? = null, val remoteVolumeRegion: String? = null, val remoteVolumeResourceId: String? = null, val replicationId: String, val replicationSchedule: String? = null)

Replication properties

Link copied to clipboard
data class ReplicationResponse(val endpointType: String? = null, val remoteVolumeRegion: String? = null, val remoteVolumeResourceId: String, val replicationId: String, val replicationSchedule: String? = null)

Replication properties

Link copied to clipboard
data class SystemDataResponse(val createdAt: String? = null, val createdBy: String? = null, val createdByType: String? = null, val lastModifiedAt: String? = null, val lastModifiedBy: String? = null, val lastModifiedByType: String? = null)

Metadata pertaining to creation and last modification of the resource.

Link copied to clipboard
data class UserAssignedIdentityResponse(val clientId: String, val principalId: String)

User assigned identity properties

Link copied to clipboard
data class VolumeBackupPropertiesResponse(val backupPolicyId: String? = null, val backupVaultId: String? = null, val policyEnforced: Boolean? = null)

Volume Backup Properties

Link copied to clipboard
data class VolumeBackupsResponse(val backupsCount: Int? = null, val policyEnabled: Boolean? = null, val volumeName: String? = null, val volumeResourceId: String? = null)

Volume details using the backup policy

Link copied to clipboard
data class VolumeGroupMetaDataResponse(val applicationIdentifier: String? = null, val applicationType: String? = null, val globalPlacementRules: List<PlacementKeyValuePairsResponse>? = null, val groupDescription: String? = null, val volumesCount: Double)

Volume group properties

Link copied to clipboard
data class VolumeGroupVolumePropertiesResponse(val actualThroughputMibps: Double, val avsDataStore: String? = null, val backupId: String? = null, val baremetalTenantId: String, val capacityPoolResourceId: String? = null, val cloneProgress: Int, val coolAccess: Boolean? = null, val coolAccessRetrievalPolicy: String? = null, val coolAccessTieringPolicy: String? = null, val coolnessPeriod: Int? = null, val creationToken: String, val dataProtection: VolumePropertiesResponseDataProtection? = null, val dataStoreResourceId: List<String>, val defaultGroupQuotaInKiBs: Double? = null, val defaultUserQuotaInKiBs: Double? = null, val deleteBaseSnapshot: Boolean? = null, val effectiveNetworkFeatures: String, val enableSubvolumes: String? = null, val encrypted: Boolean, val encryptionKeySource: String? = null, val exportPolicy: VolumePropertiesResponseExportPolicy? = null, val fileAccessLogs: String, val fileSystemId: String, val id: String, val isDefaultQuotaEnabled: Boolean? = null, val isLargeVolume: Boolean? = null, val isRestoring: Boolean? = null, val kerberosEnabled: Boolean? = null, val keyVaultPrivateEndpointResourceId: String? = null, val ldapEnabled: Boolean? = null, val maximumNumberOfFiles: Double, val mountTargets: List<MountTargetPropertiesResponse>, val name: String? = null, val networkFeatures: String? = null, val networkSiblingSetId: String, val originatingResourceId: String, val placementRules: List<PlacementKeyValuePairsResponse>? = null, val protocolTypes: List<String>? = null, val provisionedAvailabilityZone: String, val provisioningState: String, val proximityPlacementGroup: String? = null, val securityStyle: String? = null, val serviceLevel: String? = null, val smbAccessBasedEnumeration: String? = null, val smbContinuouslyAvailable: Boolean? = null, val smbEncryption: Boolean? = null, val smbNonBrowsable: String? = null, val snapshotDirectoryVisible: Boolean? = null, val snapshotId: String? = null, val storageToNetworkProximity: String, val subnetId: String, val t2Network: String, val tags: Map<String, String>? = null, val throughputMibps: Double? = null, val type: String, val unixPermissions: String? = null, val usageThreshold: Double, val volumeGroupName: String, val volumeSpecName: String? = null, val volumeType: String? = null, val zones: List<String>? = null)

Volume resource

Link copied to clipboard
data class VolumePropertiesResponseDataProtection(val backup: VolumeBackupPropertiesResponse? = null, val replication: ReplicationObjectResponse? = null, val snapshot: VolumeSnapshotPropertiesResponse? = null, val volumeRelocation: VolumeRelocationPropertiesResponse? = null)

DataProtection type volumes include an object containing details of the replication

Link copied to clipboard

Set of export policy rules

Link copied to clipboard
data class VolumeRelocationPropertiesResponse(val readyToBeFinalized: Boolean, val relocationRequested: Boolean? = null)

Volume relocation properties

Link copied to clipboard
data class VolumeSnapshotPropertiesResponse(val snapshotPolicyId: String? = null)

Volume Snapshot Properties

Link copied to clipboard
data class WeeklyScheduleResponse(val day: String? = null, val hour: Int? = null, val minute: Int? = null, val snapshotsToKeep: Int? = null, val usedBytes: Double? = null)

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