swagger: '2.0' info: version: 2020-08-01-preview title: Microsoft Azure AccessControlClient AccessConnector Snapshot Policy List Volumes API schemes: - https tags: - name: Snapshot Policy List Volumes paths: ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/snapshotPolicies/{snapshotPolicyName}/volumes : get: tags: - Snapshot Policy List Volumes summary: Microsoft Azure Get Volumes For Snapshot Policy description: Get volumes associated with snapshot policy operationId: microsoftAzureSnapshotpoliciesListvolumes parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/AccountName' - $ref: '#/parameters/SnapshotPolicyName' - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter responses: '200': description: OK schema: $ref: '#/definitions/snapshotPolicyVolumeList' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: SnapshotPolicies_ListVolumes: $ref: examples/SnapshotPolicies_ListVolumes.json definitions: exportPolicyRule: description: Volume Export Policy Rule type: object properties: ruleIndex: type: integer description: Order index format: int32 unixReadOnly: type: boolean description: Read only access unixReadWrite: type: boolean description: Read and write access kerberos5ReadOnly: type: boolean description: Kerberos5 Read only access. To be use with swagger version 2020-05-01 or later example: false default: false kerberos5ReadWrite: type: boolean description: Kerberos5 Read and write access. To be use with swagger version 2020-05-01 or later example: false default: false kerberos5iReadOnly: type: boolean description: Kerberos5i Read only access. To be use with swagger version 2020-05-01 or later example: false default: false kerberos5iReadWrite: type: boolean description: Kerberos5i Read and write access. To be use with swagger version 2020-05-01 or later example: false default: false kerberos5pReadOnly: type: boolean description: Kerberos5p Read only access. To be use with swagger version 2020-05-01 or later example: false default: false kerberos5pReadWrite: type: boolean description: Kerberos5p Read and write access. To be use with swagger version 2020-05-01 or later example: false default: false cifs: type: boolean description: Allows CIFS protocol nfsv3: type: boolean description: Allows NFSv3 protocol. Enable only for NFSv3 type volumes nfsv41: type: boolean description: Allows NFSv4.1 protocol. Enable only for NFSv4.1 type volumes allowedClients: type: string description: Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names hasRootAccess: type: boolean description: Has root access to volume example: true default: true chownMode: type: string description: 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. default: Restricted enum: - Restricted - Unrestricted x-ms-enum: name: ChownMode modelAsString: true smbNonBrowsable: title: smbNonBrowsable type: string description: Enables non-browsable property for SMB Shares. Only applicable for SMB/DualProtocol volume enum: - Disabled - Enabled x-ms-enum: name: smbNonBrowsable modelAsString: true values: - value: Disabled description: smbNonBrowsable share setting is disabled - value: Enabled description: smbNonBrowsable share setting is enabled example: Enabled serviceLevel: title: serviceLevel type: string description: The service level of the file system enum: - Standard - Premium - Ultra - StandardZRS default: Premium x-ms-enum: name: ServiceLevel modelAsString: true values: - value: Standard description: Standard service level - value: Premium description: Premium service level - value: Ultra description: Ultra service level - value: StandardZRS description: Zone redundant storage service level volumeProperties: description: Volume properties type: object required: - creationToken - usageThreshold - subnetId properties: fileSystemId: title: FileSystem ID type: string readOnly: true description: Unique FileSystem Identifier. pattern: ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$ maxLength: 36 minLength: 36 example: 9760acf5-4638-11e7-9bdb-020073ca7778 creationToken: title: Creation Token or File Path type: string description: A unique file path for the volume. Used when creating mount targets pattern: ^[a-zA-Z][a-zA-Z0-9\-]{0,79}$ minLength: 1 maxLength: 80 example: some-amazing-filepath serviceLevel: title: serviceLevel $ref: '#/definitions/serviceLevel' usageThreshold: title: usageThreshold type: integer format: int64 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, 500Tib for LargeVolume or 2400Tib for LargeVolume on exceptional basis. Specified in bytes. minimum: 107374182400 maximum: 2638827906662400 default: 107374182400 example: 107374182400 exportPolicy: title: exportPolicy description: Set of export policy rules properties: rules: title: Export policy rule description: Export policy rule type: array items: $ref: '#/definitions/exportPolicyRule' x-ms-identifiers: - ruleIndex protocolTypes: title: protocolTypes description: Set of protocol types, default NFSv3, CIFS for SMB protocol type: array items: type: string example: - NFSv4.1 provisioningState: type: string readOnly: true description: Azure lifecycle management snapshotId: title: Snapshot ID type: string x-nullable: true x-ms-mutability: - read - create description: UUID v4 or resource identifier used to identify the Snapshot. example: 9760acf5-4638-11e7-9bdb-020073ca3333 deleteBaseSnapshot: type: boolean description: If enabled (true) the snapshot the volume was created from will be automatically deleted after the volume create operation has finished. Defaults to false backupId: title: Backup ID type: string x-nullable: true x-ms-mutability: - read - create description: UUID v4 or resource identifier used to identify the Backup. example: 9760acf5-4638-11e7-9bdb-020073ca3333 baremetalTenantId: title: Baremetal Tenant ID type: string readOnly: true description: Unique Baremetal Tenant Identifier. example: 9560acf5-4e3a-12e7-9bdb-02007cca7779 subnetId: type: string description: The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes networkFeatures: $ref: '#/definitions/networkFeatures' networkSiblingSetId: title: Network Sibling Set ID description: Network Sibling Set ID for the the group of volumes sharing networking resources. type: string readOnly: true pattern: ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$ maxLength: 36 minLength: 36 example: 9760acf5-4638-11e7-9bdb-020073ca3333 storageToNetworkProximity: title: Storage to Network Proximity description: Provides storage to network proximity information for the volume. type: string enum: - Default - T1 - T2 - AcrossT2 readOnly: true x-ms-enum: name: VolumeStorageToNetworkProximity modelAsString: true values: - value: Default description: Basic storage to network connectivity. - value: T1 description: Standard T1 storage to network connectivity. - value: T2 description: Standard T2 storage to network connectivity. - value: AcrossT2 description: Standard AcrossT2 storage to network connectivity. example: T1 mountTargets: title: mountTargets type: array readOnly: true description: List of mount targets items: $ref: '#/definitions/mountTargetProperties' x-ms-identifiers: - fileSystemId volumeType: type: string description: What type of volume is this. For destination volumes in Cross Region Replication, set type to DataProtection. For creating clone volume, set type to ShortTermClone example: DataProtection dataProtection: title: DataProtection description: DataProtection type volumes include an object containing details of the replication properties: backup: title: Backup description: Backup Properties type: object $ref: '#/definitions/volumeBackupProperties' replication: title: Replication description: Replication properties type: object $ref: '#/definitions/replicationObject' snapshot: title: Snapshot description: Snapshot properties. $ref: '#/definitions/volumeSnapshotProperties' volumeRelocation: title: VolumeRelocation description: VolumeRelocation properties type: object $ref: '#/definitions/volumeRelocationProperties' isRestoring: type: boolean description: Restoring snapshotDirectoryVisible: type: boolean default: true description: If enabled (true) the volume will contain a read-only snapshot directory which provides access to each of the volume's snapshots (defaults to true). kerberosEnabled: type: boolean description: Describe if a volume is KerberosEnabled. To be use with swagger version 2020-05-01 or later x-ms-mutability: - read - create example: false default: false securityStyle: type: string description: The security style of volume, default unix, defaults to ntfs for dual protocol or CIFS protocol default: unix enum: - ntfs - unix x-ms-enum: name: SecurityStyle modelAsString: true smbEncryption: type: boolean description: Enables encryption for in-flight smb3 data. Only applicable for SMB/DualProtocol volume. To be used with swagger version 2020-08-01 or later example: false default: false smbAccessBasedEnumeration: $ref: '#/definitions/smbAccessBasedEnumeration' smbNonBrowsable: $ref: '#/definitions/smbNonBrowsable' smbContinuouslyAvailable: type: boolean description: Enables continuously available share property for smb volume. Only applicable for SMB volume example: false default: false throughputMibps: title: Maximum throughput in MiB/s that can be achieved by this volume and this will be accepted as input only for manual qosType volume type: number x-nullable: true example: 128.223 actualThroughputMibps: type: number description: Actual throughput in MiB/s for auto qosType volumes calculated based on size and serviceLevel example: 164.221 readOnly: true encryptionKeySource: description: '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''' type: string enum: - Microsoft.NetApp - Microsoft.KeyVault x-ms-enum: name: EncryptionKeySource modelAsString: true values: - value: Microsoft.NetApp description: Microsoft-managed key encryption - value: Microsoft.KeyVault description: Customer-managed key encryption default: Microsoft.NetApp keyVaultPrivateEndpointResourceId: type: string description: The resource ID of private endpoint for KeyVault. It must reside in the same VNET as the volume. Only applicable if encryptionKeySource = 'Microsoft.KeyVault'. ldapEnabled: type: boolean description: Specifies whether LDAP is enabled or not for a given NFS volume. example: false default: false coolAccess: type: boolean description: Specifies whether Cool Access(tiering) is enabled for the volume. example: false default: false coolnessPeriod: type: integer description: Specifies the number of days after which data that is not accessed by clients will be tiered. example: 7 minimum: 7 maximum: 183 format: int32 coolAccessRetrievalPolicy: $ref: '#/definitions/coolAccessRetrievalPolicy' unixPermissions: type: string description: 'UNIX permissions for NFS volume accepted in octal 4 digit format. First digit selects the set user ID(4), set group ID (2) and sticky (1) attributes. Second digit selects permission for the owner of the file: read (4), write (2) and execute (1). Third selects permissions for other users in the same group. the fourth for other users not in the group. 0755 - gives read/write/execute permissions to owner and read/execute to group and other users.' minLength: 4 maxLength: 4 x-nullable: true example: '0770' cloneProgress: description: When a volume is being restored from another volume's snapshot, will show the percentage completion of this cloning process. When this value is empty/null there is no cloning process currently happening on this volume. This value will update every 5 minutes during cloning. type: integer format: int32 example: 10 x-nullable: true readOnly: true fileAccessLogs: type: string description: Flag indicating whether file access logs are enabled for the volume, based on active diagnostic settings present on the volume. readOnly: true enum: - Enabled - Disabled x-ms-enum: name: fileAccessLogs modelAsString: true values: - value: Enabled description: fileAccessLogs are enabled - value: Disabled description: fileAccessLogs are not enabled example: Disabled default: Disabled avsDataStore: title: avsDataStore type: string description: Specifies whether the volume is enabled for Azure VMware Solution (AVS) datastore purpose enum: - Enabled - Disabled x-ms-enum: name: avsDataStore modelAsString: true values: - value: Enabled description: avsDataStore is enabled - value: Disabled description: avsDataStore is disabled example: Enabled default: Disabled dataStoreResourceId: title: dataStoreResourceId description: Data store resource unique identifier type: array items: type: string readOnly: true isDefaultQuotaEnabled: type: boolean description: Specifies if default quota is enabled for the volume. example: false default: false defaultUserQuotaInKiBs: type: integer format: int64 description: Default user quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies . example: 4 default: 0 defaultGroupQuotaInKiBs: type: integer format: int64 description: Default group quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies. example: 4 default: 0 maximumNumberOfFiles: type: integer format: int64 readOnly: true description: Maximum number of files allowed. Needs a service request in order to be changed. Only allowed to be changed if volume quota is more than 4TiB. example: 100000000 volumeGroupName: type: string description: Volume Group Name readOnly: true capacityPoolResourceId: type: string description: Pool Resource Id used in case of creating a volume through volume group proximityPlacementGroup: type: string description: Proximity placement group associated with the volume example: /subscriptions/aaaaaaaa-1234-1234-1224-234567891011/resourceGroups/testGroup/providers/Microsoft.Compute/proximityPlacementGroups/testppg t2Network: type: string description: T2 network information example: Test-T2-Alias readOnly: true volumeSpecName: type: string description: Volume spec name is the application specific designation or identifier for the particular volume in a volume group for e.g. data, log example: Data encrypted: type: boolean description: Specifies if the volume is encrypted or not. Only available on volumes created or updated after 2022-01-01. readOnly: true placementRules: title: Volume placement rules description: Application specific placement rules for the particular volume type: array items: $ref: '#/definitions/placementKeyValuePairs' x-ms-identifiers: - key enableSubvolumes: type: string description: Flag indicating whether subvolume operations are enabled on the volume example: Enabled default: Disabled enum: - Enabled - Disabled x-ms-enum: name: enableSubvolumes modelAsString: true values: - value: Enabled description: subvolumes are enabled - value: Disabled description: subvolumes are not enabled provisionedAvailabilityZone: title: Provisioned Availability Zone type: string readOnly: true description: The availability zone where the volume is provisioned. This refers to the logical availability zone where the volume resides. example: '2' x-nullable: true isLargeVolume: title: Is Large Volume type: boolean description: Specifies whether volume is a Large Volume or Regular Volume. example: false default: false originatingResourceId: title: Originating Resource Id type: string description: Id of the snapshot or backup that the volume is restored from. example: /subscriptions/aaaaaaaa-1234-1234-1224-234567891011/resourceGroups/testGroup/providers/Microsoft.NetApp/netAppAccounts/accountOriginatingResourceId/capacityPools/originatingResourceIdPool/volumes/theOriginalVolume/snapshots/theSnapshot readOnly: true x-nullable: true inheritedSizeInBytes: title: inheritedSizeInBytes type: integer format: int64 description: Space shared by short term clone volume with parent volume in bytes. readOnly: true x-nullable: true remotePath: description: The full path to a volume that is to be migrated into ANF. Required for Migration volumes type: object required: - externalHostName - serverName - volumeName properties: externalHostName: type: string description: The Path to a ONTAP Host serverName: type: string description: The name of a server on the ONTAP Host volumeName: type: string description: The name of a volume on the server volume: description: Volume resource type: object required: - location - properties allOf: - $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource properties: etag: readOnly: true type: string description: A unique read-only string that changes whenever the resource is updated. zones: type: array description: Availability Zone x-ms-mutability: - read - create items: type: string maxLength: 255 minLength: 1 example: '1' properties: description: Volume properties $ref: '#/definitions/volumeProperties' x-ms-client-flatten: true volumeRelocationProperties: description: Volume relocation properties type: object properties: relocationRequested: type: boolean description: Has relocation been requested for this volume readyToBeFinalized: type: boolean readOnly: true description: Has relocation finished and is ready to be cleaned up volumeSnapshotProperties: description: Volume Snapshot Properties type: object properties: snapshotPolicyId: type: string description: Snapshot Policy ResourceId replicationObject: description: Replication properties type: object required: - remoteVolumeResourceId properties: replicationId: type: string description: Id readOnly: true endpointType: type: string description: Indicates whether the local volume is the source or destination for the Volume Replication enum: - src - dst x-ms-enum: name: EndpointType modelAsString: true replicationSchedule: type: string description: Schedule enum: - _10minutely - hourly - daily x-ms-enum: name: ReplicationSchedule modelAsString: true remoteVolumeResourceId: type: string description: The resource ID of the remote volume. Required for cross region and cross zone replication x-ms-mutability: - read - create remotePath: description: The full path to a volume that is to be migrated into ANF. Required for Migration volumes type: object $ref: '#/definitions/remotePath' x-ms-mutability: - read - create remoteVolumeRegion: type: string description: The remote region for the other end of the Volume Replication. networkFeatures: title: Network features description: Network features available to the volume, or current state of update. type: string enum: - Basic - Standard - Basic_Standard - Standard_Basic x-ms-enum: name: NetworkFeatures modelAsString: true values: - value: Basic description: Basic network features. - value: Standard description: Standard network features. - value: Basic_Standard description: Updating from Basic to Standard network features. - value: Standard_Basic description: Updating from Standard to Basic network features. example: Standard default: Basic placementKeyValuePairs: description: Application specific parameters for the placement of volumes in the volume group type: object required: - key - value properties: key: type: string description: Key for an application specific parameter for the placement of volumes in the volume group example: key1 value: type: string description: Value for an application specific parameter for the placement of volumes in the volume group example: value1 mountTargetProperties: description: Mount target properties type: object required: - fileSystemId properties: mountTargetId: title: mountTargetId type: string readOnly: true description: UUID v4 used to identify the MountTarget pattern: ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$ maxLength: 36 minLength: 36 example: 9760acf5-4638-11e7-9bdb-020073ca3333 fileSystemId: title: fileSystemId type: string description: UUID v4 used to identify the MountTarget pattern: ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$ maxLength: 36 minLength: 36 example: 9760acf5-4638-11e7-9bdb-020073ca3333 ipAddress: title: ipAddress description: The mount target's IPv4 address type: string readOnly: true example: 1.2.3.4 smbServerFqdn: title: smbServerFQDN description: The SMB server's Fully Qualified Domain Name, FQDN type: string example: fullyqualified.domainname.com coolAccessRetrievalPolicy: type: string description: "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: \n Default - Data will be pulled from cool tier to standard storage on random reads. This policy is the default.\n OnRead - All client-driven data read is pulled from cool tier to standard storage on both sequential and random reads.\n Never - No client-driven data is pulled from cool tier to standard storage." enum: - Default - OnRead - Never x-ms-enum: name: coolAccessRetrievalPolicy modelAsString: true smbAccessBasedEnumeration: title: smbAccessBasedEnumeration type: string description: Enables access-based enumeration share property for SMB Shares. Only applicable for SMB/DualProtocol volume enum: - Disabled - Enabled x-ms-enum: name: smbAccessBasedEnumeration modelAsString: true values: - value: Disabled description: smbAccessBasedEnumeration share setting is disabled - value: Enabled description: smbAccessBasedEnumeration share setting is enabled x-nullable: true example: Enabled volumeBackupProperties: description: Volume Backup Properties type: object properties: backupPolicyId: type: string description: Backup Policy Resource ID policyEnforced: type: boolean description: Policy Enforced backupEnabled: type: boolean description: Backup Enabled backupVaultId: type: string description: Backup Vault Resource ID snapshotPolicyVolumeList: description: Volumes associated with snapshot policy type: object properties: value: description: List of volumes type: array items: $ref: '#/definitions/volume' parameters: AccountName: name: accountName type: string pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-_]{0,127}$ in: path required: true description: The name of the NetApp account x-ms-parameter-location: method SnapshotPolicyName: name: snapshotPolicyName type: string in: path required: true description: The name of the snapshot policy x-ms-parameter-location: method x-ms-parameterized-host: hostTemplate: '{endpoint}' useSchemePrefix: false parameters: - $ref: '#/parameters/Endpoint'