Snapshot Policies - List Volumes

Служба:

Azure NetApp Files

Версия API:

2024-03-01

Получение томов для политики моментальных снимков
Получение томов, связанных с политикой моментальных снимков

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/snapshotPolicies/{snapshotPolicyName}/volumes?api-version=2024-03-01

Параметры URI

Имя	В	Обязательно	Тип	Описание
accountName	path	True	string	Имя учетной записи NetApp Шаблон регулярного выражения: ^[a-zA-Z0-9][a-zA-Z0-9\-_]{0,127}$
resourceGroupName	path	True	string	Имя группы ресурсов. Имя не учитывает регистр.
snapshotPolicyName	path	True	string	Имя политики моментальных снимков
subscriptionId	path	True	string uuid	Идентификатор целевой подписки. Значение должно быть UUID.
api-version	query	True	string	Версия API, используемая для этой операции.

Ответы

Имя	Тип	Описание
200 OK	snapshotPolicyVolumeList	ХОРОШО
Other Status Codes	ErrorResponse	Ответ на ошибку, описывающий причину сбоя операции.

Безопасность

azure_auth

Поток OAuth2 Azure Active Directory

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

SnapshotPolicies_ListVolumes

Образец запроса

HTTP

GET https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/snapshotPolicies/snapshotPolicyName/volumes?api-version=2024-03-01

Пример ответа

Код состояния:

200

{
  "value": [
    {
      "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1",
      "name": "account1/pool1/volume1",
      "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes",
      "location": "eastus",
      "properties": {
        "fileSystemId": "9760acf5-4638-11e7-9bdb-020073ca7778",
        "creationToken": "some-amazing-filepath",
        "usageThreshold": 107374182400,
        "serviceLevel": "Premium",
        "provisioningState": "Succeeded",
        "throughputMibps": 128,
        "subnetId": "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3"
      }
    }
  ]
}

Определения

Имя	Описание
avsDataStore	avsDataStore
ChownMode	Этот параметр указывает, кто авторизован для изменения владения файлом. ограниченный — только корневой пользователь может изменить владение файлом. без ограничений — пользователи, не являющиеся корневыми, могут изменить владение файлами, которыми они владеет.
coolAccessRetrievalPolicy	coolAccessRetrievalPolicy определяет поведение извлечения данных из холодного уровня в стандартное хранилище на основе шаблона чтения для томов с поддержкой холодного доступа. Возможные значения этого поля: по умолчанию данные будут извлекаться из холодного уровня в стандартное хранилище при случайных считываниях. Эта политика используется по умолчанию. OnRead — все данные, управляемые клиентом, извлекается из холодного уровня в стандартное хранилище как на последовательное, так и случайное чтение. Никогда . Данные на основе клиента не извлекается из холодного уровня в стандартное хранилище.
createdByType	Тип удостоверения, создавшего ресурс.
DataProtection	DataProtection
enableSubvolumes	Флаг, указывающий, включены ли операции подволок в томе
EncryptionKeySource	Источник ключа, используемый для шифрования данных в томе. Применимо, если у учетной записи NetApp есть encryption.keySource = Microsoft.KeyVault. Возможные значения (без учета регистра): "Microsoft.NetApp, Microsoft.KeyVault"
EndpointType	Указывает, является ли локальный том источником или назначением для репликации томов.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Ответ на ошибку
ExportPolicy	exportPolicy
exportPolicyRule	Правило политики экспорта томов
fileAccessLogs	Флаг, указывающий, включены ли журналы доступа к файлам для тома на основе активных параметров диагностики, присутствующих на томе.
mountTargetProperties	Подключение целевых свойств
NetworkFeatures	Сетевые функции
placementKeyValuePairs	Конкретные параметры приложения для размещения томов в группе томов
replicationObject	Свойства репликации
ReplicationSchedule	Расписание
SecurityStyle	Стиль безопасности тома, по умолчанию unix, по умолчанию используется для ntfs для двойного протокола или протокола CIFS.
ServiceLevel	serviceLevel
smbAccessBasedEnumeration	smbAccessBasedEnumeration
smbNonBrowsable	smbNonBrowsable
snapshotPolicyVolumeList	Тома, связанные с политикой моментальных снимков
systemData	Метаданные, относящиеся к созданию и последнему изменении ресурса.
volume	Ресурс тома
volumeBackupProperties	Свойства резервного копирования томов
volumeRelocationProperties	Свойства перемещения тома
volumeSnapshotProperties	Свойства моментального снимка тома
VolumeStorageToNetworkProximity	Близкое хранилище к сети

avsDataStore

avsDataStore

Имя	Тип	Описание
Disabled	string	avsDataStore отключен
Enabled	string	avsDataStore включен

ChownMode

Этот параметр указывает, кто авторизован для изменения владения файлом. ограниченный — только корневой пользователь может изменить владение файлом. без ограничений — пользователи, не являющиеся корневыми, могут изменить владение файлами, которыми они владеет.

Имя	Тип	Описание
Restricted	string
Unrestricted	string

coolAccessRetrievalPolicy

coolAccessRetrievalPolicy определяет поведение извлечения данных из холодного уровня в стандартное хранилище на основе шаблона чтения для томов с поддержкой холодного доступа. Возможные значения этого поля: по умолчанию данные будут извлекаться из холодного уровня в стандартное хранилище при случайных считываниях. Эта политика используется по умолчанию. OnRead — все данные, управляемые клиентом, извлекается из холодного уровня в стандартное хранилище как на последовательное, так и случайное чтение. Никогда . Данные на основе клиента не извлекается из холодного уровня в стандартное хранилище.

Имя	Тип	Описание
Default	string
Never	string
OnRead	string

createdByType

Тип удостоверения, создавшего ресурс.

Имя	Тип	Описание
Application	string
Key	string
ManagedIdentity	string
User	string

DataProtection

DataProtection

Имя	Тип	Описание
backup	volumeBackupProperties	Резервная копия Свойства резервного копирования
replication	replicationObject	Репликация Свойства репликации
snapshot	volumeSnapshotProperties	Снимок Свойства моментального снимка.
volumeRelocation	volumeRelocationProperties	VolumeRelocation Свойства VolumeRelocation

enableSubvolumes

Флаг, указывающий, включены ли операции подволок в томе

Имя	Тип	Описание
Disabled	string	вложенные выражения не включены
Enabled	string	Вложенные выражения включены

EncryptionKeySource

Источник ключа, используемый для шифрования данных в томе. Применимо, если у учетной записи NetApp есть encryption.keySource = Microsoft.KeyVault. Возможные значения (без учета регистра): "Microsoft.NetApp, Microsoft.KeyVault"

Имя	Тип	Описание
Microsoft.KeyVault	string	Шифрование ключей, управляемых клиентом
Microsoft.NetApp	string	Шифрование ключей, управляемых корпорацией Майкрософт

EndpointType

Указывает, является ли локальный том источником или назначением для репликации томов.

Имя	Тип	Описание
dst	string
src	string

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

Имя	Тип	Описание
info	object	Дополнительные сведения.
type	string	Дополнительный тип сведений.

ErrorDetail

Сведения об ошибке.

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorResponse

Ответ на ошибку

Имя	Тип	Описание
error	ErrorDetail	Объект ошибки.

ExportPolicy

exportPolicy

Имя	Тип	Описание
rules	exportPolicyRule[]	Правило политики экспорта Правило политики экспорта

exportPolicyRule

Правило политики экспорта томов

Имя	Тип	Default value	Описание
allowedClients	string		Спецификация входящего трафика клиента как разделенная запятыми строка с IPv4 CIDRs, адреса узла IPv4 и имена узлов
chownMode	ChownMode	Restricted	Этот параметр указывает, кто авторизован для изменения владения файлом. ограниченный — только корневой пользователь может изменить владение файлом. без ограничений — пользователи, не являющиеся корневыми, могут изменить владение файлами, которыми они владеет.
cifs	boolean		Разрешает протокол CIFS
hasRootAccess	boolean	True	Имеет корневой доступ к тому
kerberos5ReadOnly	boolean	False	Доступ только для чтения Kerberos5. Использование swagger версии 2020-05-01 или более поздней
kerberos5ReadWrite	boolean	False	Доступ на чтение и запись Kerberos5. Использование swagger версии 2020-05-01 или более поздней
kerberos5iReadOnly	boolean	False	Доступ только для чтения Kerberos5i. Использование swagger версии 2020-05-01 или более поздней
kerberos5iReadWrite	boolean	False	Доступ на чтение и запись Kerberos5i. Использование swagger версии 2020-05-01 или более поздней
kerberos5pReadOnly	boolean	False	Доступ только для чтения Kerberos5p. Использование swagger версии 2020-05-01 или более поздней
kerberos5pReadWrite	boolean	False	Доступ на чтение и запись Kerberos5p. Использование swagger версии 2020-05-01 или более поздней
nfsv3	boolean		Разрешает протокол NFSv3. Включение только для томов типов NFSv3
nfsv41	boolean		Разрешает протокол NFSv4.1. Включение только для томов типов NFSv4.1
ruleIndex	integer		Индекс заказа
unixReadOnly	boolean		Доступ только для чтения
unixReadWrite	boolean		Доступ на чтение и запись

fileAccessLogs

Флаг, указывающий, включены ли журналы доступа к файлам для тома на основе активных параметров диагностики, присутствующих на томе.

Имя	Тип	Описание
Disabled	string	fileAccessLogs не включены
Enabled	string	fileAccessLogs включены

mountTargetProperties

Подключение целевых свойств

Имя	Тип	Описание
fileSystemId	string	fileSystemId UUID версии 4, используемый для идентификации MountTarget
ipAddress	string	ipAddress IPv4-адрес целевого объекта подключения
mountTargetId	string	mountTargetId UUID версии 4, используемый для идентификации MountTarget
smbServerFqdn	string	smbServerFQDN Полное доменное имя сервера SMB

NetworkFeatures

Сетевые функции

Имя	Тип	Описание
Basic	string	Основные сетевые функции.
Basic_Standard	string	Обновление с базовых до стандартных сетевых функций.
Standard	string	Стандартные сетевые функции.
Standard_Basic	string	Обновление сетевых функций уровня "Стандартный" до "Базовый".

placementKeyValuePairs

Конкретные параметры приложения для размещения томов в группе томов

Имя	Тип	Описание
key	string	Ключ для конкретного параметра приложения для размещения томов в группе томов
value	string	Значение для конкретного параметра приложения для размещения томов в группе томов

replicationObject

Свойства репликации

Имя	Тип	Описание
endpointType	EndpointType	Указывает, является ли локальный том источником или назначением для репликации томов.
remoteVolumeRegion	string	Удаленный регион для другого конца репликации томов.
remoteVolumeResourceId	string	Идентификатор ресурса удаленного тома.
replicationId	string	Идентификатор
replicationSchedule	ReplicationSchedule	Расписание

ReplicationSchedule

Расписание

Имя	Тип	Описание
_10minutely	string
daily	string
hourly	string

SecurityStyle

Стиль безопасности тома, по умолчанию unix, по умолчанию используется для ntfs для двойного протокола или протокола CIFS.

Имя	Тип	Описание
ntfs	string
unix	string

ServiceLevel

serviceLevel

Имя	Тип	Описание
Premium	string	Уровень обслуживания уровня "Премиум"
Standard	string	Стандартный уровень обслуживания
StandardZRS	string	Уровень обслуживания избыточного между зонами хранилища
Ultra	string	Уровень обслуживания "Ультра"

smbAccessBasedEnumeration

smbAccessBasedEnumeration

Имя	Тип	Описание
Disabled	string	Параметр общей папки smbAccessBasedEnumeration отключен
Enabled	string	Параметр общего ресурса smbAccessBasedEnumeration включен

smbNonBrowsable

smbNonBrowsable

Имя	Тип	Описание
Disabled	string	Параметр общего ресурса smbNonBrowsable отключен
Enabled	string	Параметр общего ресурса smbNonBrowsable включен

snapshotPolicyVolumeList

Тома, связанные с политикой моментальных снимков

Имя	Тип	Описание
value	volume[]	Список томов

systemData

Метаданные, относящиеся к созданию и последнему изменении ресурса.

Имя	Тип	Описание
createdAt	string	Метка времени создания ресурса (UTC).
createdBy	string	Удостоверение, создающее ресурс.
createdByType	createdByType	Тип удостоверения, создавшего ресурс.
lastModifiedAt	string	Метка времени последнего изменения ресурса (UTC)
lastModifiedBy	string	Идентификатор, который последний раз изменил ресурс.
lastModifiedByType	createdByType	Тип удостоверения, который последний раз изменил ресурс.

volume

Ресурс тома

Имя	Тип	Default value	Описание
etag	string		Уникальная строка только для чтения, которая изменяется при обновлении ресурса.
id	string		Полный идентификатор ресурса для ресурса. Например, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location	string		Географическое расположение, в котором находится ресурс
name	string		Имя ресурса
properties.actualThroughputMibps	number		Фактическая пропускная способность в MiB/s для автоматических томов qosType, вычисляемых на основе размера и serviceLevel
properties.avsDataStore	avsDataStore	Disabled	avsDataStore Указывает, включен ли том для назначения хранилища данных решения Azure VMware (AVS)
properties.backupId	string		Идентификатор резервного копирования Идентификатор ресурса, используемый для идентификации резервной копии.
properties.baremetalTenantId	string		Идентификатор клиента Baremetal Уникальный идентификатор клиента Baremetal.
properties.capacityPoolResourceId	string		Идентификатор ресурса пула, используемый в случае создания тома с помощью группы томов
properties.cloneProgress	integer		При восстановлении тома из моментального снимка другого тома будет отображаться процент завершения этого клонирования. Если это значение пусто или null, процесс клонирования в настоящее время не происходит на этом томе. Это значение будет обновляться каждые 5 минут во время клонирования.
properties.coolAccess	boolean	False	Указывает, включена ли функция "Холодный доступ( уровень) для тома.
properties.coolAccessRetrievalPolicy	coolAccessRetrievalPolicy		coolAccessRetrievalPolicy определяет поведение извлечения данных из холодного уровня в стандартное хранилище на основе шаблона чтения для томов с поддержкой холодного доступа. Возможные значения этого поля: по умолчанию данные будут извлекаться из холодного уровня в стандартное хранилище при случайных считываниях. Эта политика используется по умолчанию. OnRead — все данные, управляемые клиентом, извлекается из холодного уровня в стандартное хранилище как на последовательное, так и случайное чтение. Никогда . Данные на основе клиента не извлекается из холодного уровня в стандартное хранилище.
properties.coolnessPeriod	integer		Указывает количество дней после того, как данные, к которым не обращаются клиенты, будут многоуровневы.
properties.creationToken	string		Маркер создания или путь к файлу Уникальный путь к файлу тома. Используется при создании целевых объектов подключения
properties.dataProtection	DataProtection		DataProtection Тома типа DataProtection включают объект, содержащий сведения о репликации
properties.dataStoreResourceId	string[]		dataStoreResourceId Уникальный идентификатор ресурса хранилища данных
properties.defaultGroupQuotaInKiBs	integer	0	Квота группы по умолчанию для тома в КИБ. Если задано значение isDefaultQuotaEnabled, применяется минимальное значение 4 КИБ.
properties.defaultUserQuotaInKiBs	integer	0	Квота пользователя по умолчанию для тома в КИБ. Если задано значение isDefaultQuotaEnabled, применяется минимальное значение 4 КИБ.
properties.deleteBaseSnapshot	boolean		Если этот моментальный снимок включен (true), созданный том будет автоматически удален после завершения операции создания тома. Значение по умолчанию — false
properties.enableSubvolumes	enableSubvolumes	Disabled	Флаг, указывающий, включены ли операции подволок в томе
properties.encrypted	boolean		Указывает, зашифрован ли том или нет. Доступно только для томов, созданных или обновленных после 2022-01-01.
properties.encryptionKeySource	EncryptionKeySource	Microsoft.NetApp	Источник ключа, используемый для шифрования данных в томе. Применимо, если у учетной записи NetApp есть encryption.keySource = Microsoft.KeyVault. Возможные значения (без учета регистра): "Microsoft.NetApp, Microsoft.KeyVault"
properties.exportPolicy	ExportPolicy		exportPolicy Набор правил политики экспорта
properties.fileAccessLogs	fileAccessLogs	Disabled	Флаг, указывающий, включены ли журналы доступа к файлам для тома на основе активных параметров диагностики, присутствующих на томе.
properties.fileSystemId	string		Идентификатор файловой системы Уникальный идентификатор файловой системы.
properties.isDefaultQuotaEnabled	boolean	False	Указывает, включена ли квота по умолчанию для тома.
properties.isLargeVolume	boolean	False	Большой объем Указывает, является ли том большим томом или регулярным томом.
properties.isRestoring	boolean		Восстановление
properties.kerberosEnabled	boolean	False	Опишите, является ли том KerberosEnabled. Использование swagger версии 2020-05-01 или более поздней
properties.keyVaultPrivateEndpointResourceId	string		Идентификатор ресурса частной конечной точки для KeyVault. Он должен находиться в той же виртуальной сети, что и том. Применимо только в том случае, если encryptionKeySource = Microsoft.KeyVault.
properties.ldapEnabled	boolean	False	Указывает, включен ли протокол LDAP для заданного тома NFS.
properties.maximumNumberOfFiles	integer		Максимально допустимое количество файлов. Требуется запрос на обслуживание для изменения. Допускается изменение только в том случае, если квота тома превышает 4TiB.
properties.mountTargets	mountTargetProperties[]		mountTargets Список целевых объектов подключения
properties.networkFeatures	NetworkFeatures	Basic	Сетевые функции Сетевые функции, доступные для тома или текущего состояния обновления.
properties.networkSiblingSetId	string		Идентификатор набора одноуровневых сетей Идентификатор набора одноуровневых сетей для группы томов, совместного использования сетевых ресурсов.
properties.originatingResourceId	string		Исходный идентификатор ресурса Идентификатор моментального снимка или резервного копирования, из который восстанавливается том.
properties.placementRules	placementKeyValuePairs[]		Правила размещения томов Правила размещения конкретного приложения для конкретного тома
properties.protocolTypes	string[]		protocolTypes Набор типов протоколов, стандартный протокол NFSv3, CIFS для протокола SMB
properties.provisionedAvailabilityZone	string		Подготовленная зона доступности Зона доступности, в которой подготовлен том. Это относится к логической зоне доступности, в которой находится том.
properties.provisioningState	string		Управление жизненным циклом Azure
properties.proximityPlacementGroup	string		Группа размещения близкого взаимодействия, связанная с томом
properties.securityStyle	SecurityStyle	unix	Стиль безопасности тома, по умолчанию unix, по умолчанию используется для ntfs для двойного протокола или протокола CIFS.
properties.serviceLevel	ServiceLevel	Premium	serviceLevel Уровень обслуживания файловой системы
properties.smbAccessBasedEnumeration	smbAccessBasedEnumeration		smbAccessBasedEnumeration Включает свойство общего ресурса перечисления на основе доступа для общих папок SMB. Применимо только для тома SMB/DualProtocol
properties.smbContinuouslyAvailable	boolean	False	Включает непрерывно доступное свойство общего ресурса для тома smb. Применимо только для тома SMB
properties.smbEncryption	boolean	False	Включает шифрование для данных smb3 в полете. Применимо только для тома SMB/DualProtocol. Использование с swagger версии 2020-08-01 или более поздней
properties.smbNonBrowsable	smbNonBrowsable		smbNonBrowsable Включает свойство, отличное от просмотра для общих папок SMB. Применимо только для тома SMB/DualProtocol
properties.snapshotDirectoryVisible	boolean	True	Если этот том включен (true) содержит каталог моментальных снимков только для чтения, предоставляющий доступ к каждому моментальному снимку тома (по умолчанию — true).
properties.snapshotId	string		Идентификатор моментального снимка Идентификатор ресурса, используемый для идентификации моментального снимка.
properties.storageToNetworkProximity	VolumeStorageToNetworkProximity		Близкое хранилище к сети Предоставляет хранилище для сведений о близости к сети для тома.
properties.subnetId	string		Универсальный код ресурса Azure для делегированной подсети. Должен иметь делегирование Microsoft.NetApp/volumes
properties.t2Network	string		Сведения о сети T2
properties.throughputMibps	number		Максимальная пропускная способность в MiB/s, которую можно достичь с помощью этого тома, и это будет принято только в качестве входных данных для тома qosType вручную.
properties.unixPermissions	string		Разрешения UNIX для тома NFS, принятые в восьмизначном формате. Первая цифра выбирает набор идентификаторов пользователя(4), задает идентификатор группы (2) и липкие атрибуты (1). Вторая цифра выбирает разрешение для владельца файла: чтение (4), запись (2) и выполнение (1). Третий выбирает разрешения для других пользователей в той же группе. четвертый для других пользователей, не входящих в группу. 0755 — предоставляет разрешения на чтение и запись и выполнение для владельца и чтения и выполнения для группы и других пользователей.
properties.usageThreshold	integer	0	usageThreshold Максимальная квота хранилища, допустимая для файловой системы в байтах. Это мягкая квота, используемая только для оповещений. Для обычных томов допустимые значения находятся в диапазоне от 50GiB до 100TiB. Для больших томов допустимые значения находятся в диапазоне от 100TiB до 500TiB и на исключительной основе от 2400GiB до 2400TiB. Значения, выраженные в байтах в виде нескольких 1 ГиБ.
properties.volumeGroupName	string		Имя группы томов
properties.volumeSpecName	string		Имя спецификации тома — это конкретное обозначение или идентификатор приложения для конкретного тома в группе томов для данных, журналов.
properties.volumeType	string		Какой тип тома это. Для конечных томов в репликации между регионами задайте тип DataProtection
systemData	systemData		Метаданные Azure Resource Manager, содержащие данные createdBy и modifiedBy.
tags	object		Теги ресурсов.
type	string		Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"
zones	string[]		Зона доступности

volumeBackupProperties

Свойства резервного копирования томов

Имя	Тип	Описание
backupPolicyId	string	Идентификатор ресурса политики резервного копирования
backupVaultId	string	Идентификатор ресурса Backup Vault
policyEnforced	boolean	Принудительное применение политики

volumeRelocationProperties

Свойства перемещения тома

Имя	Тип	Описание
readyToBeFinalized	boolean	Завершено перемещение и готово к очистке
relocationRequested	boolean	Запрошено перемещение для этого тома

volumeSnapshotProperties

Свойства моментального снимка тома

Имя	Тип	Описание
snapshotPolicyId	string	ResourceId политики моментальных снимков

VolumeStorageToNetworkProximity

Близкое хранилище к сети

Имя	Тип	Описание
AcrossT2	string	Стандартное хранилище ЧерезT2 к сетевому подключению.
Default	string	Базовое хранилище для сетевого подключения.
T1	string	Стандартное хранилище T1 к сетевому подключению.
T2	string	Стандартное хранилище T2 к сетевому подключению.