Volumes - Get

Serviço:: Azure NetApp Files

Versão da API:: 2025-12-01

Obter os detalhes do volume especificado

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}?api-version=2025-12-01

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
accountName	path	True	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-_]{0,127}$	O nome da conta NetApp
poolName	path	True	string minLength: 1 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-_]{0,63}$	O nome do pool de capacidade
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
subscriptionId	path	True	string (uuid)	A ID da assinatura de destino. O valor deve ser um UUID.
volumeName	path	True	string minLength: 1 maxLength: 64 pattern: ^[a-zA-Z][a-zA-Z0-9\-_]{0,63}$	O nome do volume
api-version	query	True	string minLength: 1	A versão da API a utilizar para esta operação.

Respostas

Name	Tipo	Description
200 OK	Volume	Operação do Azure concluída com êxito.
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada.

Segurança

azure_auth

Fluxo OAuth2 do Azure Ative Directory.

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	personificar a sua conta de utilizador

Exemplos

Volumes_Get

Pedido de amostra

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1?api-version=2025-12-01


/**
 * Samples for Volumes Get.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-12-01/Volumes_Get.json
     */
    /**
     * Sample code: Volumes_Get.
     * 
     * @param manager Entry point to NetAppFilesManager.
     */
    public static void volumesGet(com.azure.resourcemanager.netapp.NetAppFilesManager manager) {
        manager.volumes().getWithResponse("myRG", "account1", "pool1", "volume1", com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential

from azure.mgmt.netapp import NetAppManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-netapp
# USAGE
    python volumes_get.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = NetAppManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.volumes.get(
        resource_group_name="myRG",
        account_name="account1",
        pool_name="pool1",
        volume_name="volume1",
    )
    print(response)


# x-ms-original-file: 2025-12-01/Volumes_Get.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armnetapp_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/netapp/armnetapp/v9"
)

// Generated from example definition: 2025-12-01/Volumes_Get.json
func ExampleVolumesClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armnetapp.NewClientFactory("00000000-0000-0000-0000-000000000000", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewVolumesClient().Get(ctx, "myRG", "account1", "pool1", "volume1", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armnetapp.VolumesClientGetResponse{
	// 	Volume: &armnetapp.Volume{
	// 		Name: to.Ptr("account1/pool1/volume1"),
	// 		Type: to.Ptr("Microsoft.NetApp/netAppAccounts/capacityPools/volumes"),
	// 		ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1"),
	// 		Location: to.Ptr("eastus"),
	// 		Properties: &armnetapp.VolumeProperties{
	// 			CreationToken: to.Ptr("my-unique-file-path"),
	// 			FileSystemID: to.Ptr("9760acf5-4638-11e7-9bdb-020073ca7778"),
	// 			NetworkFeatures: to.Ptr(armnetapp.NetworkFeaturesStandard),
	// 			NetworkSiblingSetID: to.Ptr("0f434a03-ce0b-4935-81af-d98652ffb1c4"),
	// 			ProvisioningState: to.Ptr("Succeeded"),
	// 			ServiceLevel: to.Ptr(armnetapp.ServiceLevelPremium),
	// 			StorageToNetworkProximity: to.Ptr(armnetapp.VolumeStorageToNetworkProximityT2),
	// 			SubnetID: to.Ptr("/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3"),
	// 			ThroughputMibps: to.Ptr[float32](128),
	// 			UsageThreshold: to.Ptr[int64](107374182400),
	// 		},
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { NetAppManagementClient } = require("@azure/arm-netapp");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to get the details of the specified volume
 *
 * @summary get the details of the specified volume
 * x-ms-original-file: 2025-12-01/Volumes_Get.json
 */
async function volumesGet() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "00000000-0000-0000-0000-000000000000";
  const client = new NetAppManagementClient(credential, subscriptionId);
  const result = await client.volumes.get("myRG", "account1", "pool1", "volume1");
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.NetApp.Models;
using Azure.ResourceManager.NetApp;

// Generated from example definition: specification/netapp/resource-manager/Microsoft.NetApp/NetApp/stable/2025-12-01/examples/Volumes_Get.json
// this example is just showing the usage of "Volumes_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this CapacityPoolResource created on azure
// for more information of creating CapacityPoolResource, please refer to the document of CapacityPoolResource
string subscriptionId = "00000000-0000-0000-0000-000000000000";
string resourceGroupName = "myRG";
string accountName = "account1";
string poolName = "pool1";
ResourceIdentifier capacityPoolResourceId = CapacityPoolResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, accountName, poolName);
CapacityPoolResource capacityPool = client.GetCapacityPoolResource(capacityPoolResourceId);

// get the collection of this NetAppVolumeResource
NetAppVolumeCollection collection = capacityPool.GetNetAppVolumes();

// invoke the operation
string volumeName = "volume1";
NullableResponse<NetAppVolumeResource> response = await collection.GetIfExistsAsync(volumeName);
NetAppVolumeResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine("Succeeded with null as result");
}
else
{
    // the variable result is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    NetAppVolumeData resourceData = result.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Resposta da amostra

Código de estado:: 200

{
  "name": "account1/pool1/volume1",
  "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1",
  "location": "eastus",
  "properties": {
    "creationToken": "my-unique-file-path",
    "fileSystemId": "9760acf5-4638-11e7-9bdb-020073ca7778",
    "networkFeatures": "Standard",
    "networkSiblingSetId": "0f434a03-ce0b-4935-81af-d98652ffb1c4",
    "provisioningState": "Succeeded",
    "serviceLevel": "Premium",
    "storageToNetworkProximity": "T2",
    "subnetId": "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3",
    "throughputMibps": 128,
    "usageThreshold": 107374182400
  }
}

Definições

Name	Description
AcceptGrowCapacityPoolForShortTermCloneSplit	Ao dividir automaticamente o volume de clone de curto prazo, se o pool pai não tiver espaço suficiente para acomodar o volume após a divisão, ele será automaticamente redimensionado, o que levará a um aumento do faturamento. Para aceitar o crescimento automático do tamanho do pool de capacidade e criar um volume de clone de curto prazo, defina a propriedade como aceita.
ActualRansomwareProtectionState	O estado real do recurso Proteção Avançada contra Ransomware
AvsDataStore	Especifica se o volume está habilitado para a finalidade do armazenamento de dados do Azure VMware Solution (AVS)
ChownMode	Este parâmetro especifica quem está autorizado a alterar a propriedade de um arquivo. restricted - Somente o usuário root pode alterar a propriedade do arquivo. irrestrito - Usuários não-root podem alterar a propriedade dos arquivos que possuem.
CoolAccessRetrievalPolicy	coolAccessRetrievalPolicy determina o comportamento de recuperação de dados da camada fria para o armazenamento padrão com base no padrão de leitura para volumes habilitados para acesso legal. Os valores possíveis para este campo são: Padrão - Os dados serão extraídos do nível legal para o armazenamento padrão em leituras aleatórias. Esta política é o padrão. OnRead - Toda a leitura de dados orientada pelo cliente é extraída do nível legal para o armazenamento padrão em leituras sequenciais e aleatórias. Nunca - Nenhum dado controlado pelo cliente é extraído do nível legal para o armazenamento padrão.
CoolAccessTieringPolicy	coolAccessTieringPolicy determina quais blocos de dados frios são movidos para a camada fria. Os valores possíveis para este campo são: Auto - Move blocos de dados frios do usuário nas cópias de instantâneo e no sistema de arquivos ativo para a camada legal. Esta política é o padrão. SnapshotOnly - Move os blocos de dados do usuário das cópias do Instantâneo de Volume que não estão associadas ao sistema de arquivos ativo para a camada legal.
createdByType	O tipo de identidade que criou o recurso.
DesiredRansomwareProtectionState	O estado desejado do recurso Proteção Avançada contra Ransomware
DestinationReplication	Propriedades de replicação de destino
EnableSubvolumes	Sinalizador que indica se as operações de subvolume estão habilitadas no volume
EncryptionKeySource	Origem da chave usada para criptografar dados em volume. Aplicável se a conta NetApp tiver encryption.keySource = 'Microsoft.KeyVault'. Os valores possíveis (sem distinção entre maiúsculas e minúsculas) são: 'Microsoft.NetApp, Microsoft.KeyVault'
EndpointType	Indica se o volume local é a origem ou o destino da Replicação de Volume
ErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
ExportPolicyRule	Regra de Política de Exportação de Volume
FileAccessLogs	Sinalizador que indica se os logs de acesso ao arquivo estão habilitados para o volume, com base nas configurações de diagnóstico ativas presentes no volume.
MountTargetProperties	Propriedades de destino de montagem
NetworkFeatures	Recursos de rede disponíveis para o volume ou estado atual da atualização.
PlacementKeyValuePairs	Parâmetros específicos de aplicação para a colocação de volumes no grupo de volumes
RansomwareProtectionSettings	Configurações de relatórios avançados de proteção contra ransomware (ARP)
RemotePath	O caminho completo para um volume que deve ser migrado para ANF. Necessário para volumes de migração
ReplicationObject	Propriedades de replicação
ReplicationSchedule	Schedule
ReplicationType	Indica se a replicação é entre zonas ou entre regiões.
SecurityStyle	O estilo de segurança do volume, padrão unix, padrão para ntfs para protocolo duplo ou protocolo CIFS
ServiceLevel	O nível de serviço do sistema de arquivos
SmbAccessBasedEnumeration	Habilita a propriedade de compartilhamento de enumeração baseada em acesso para Compartilhamentos SMB. Aplicável apenas para volume SMB/DualProtocol
SmbNonBrowsable	Habilita a propriedade não navegável para Compartilhamentos SMB. Aplicável apenas para volume SMB/DualProtocol
systemData	Metadados referentes à criação e última modificação do recurso.
Volume	Recurso de volume
VolumeBackupProperties	Propriedades de backup de volume
VolumePropertiesDataProtection	Os volumes do tipo DataProtection incluem um objeto que contém detalhes da replicação
VolumePropertiesExportPolicy	Conjunto de regras da política de exportação
VolumeRelocationProperties	Propriedades de realocação de volume
VolumeSnapshotProperties	Propriedades do instantâneo de volume
VolumeStorageToNetworkProximity	Fornece armazenamento para informações de proximidade de rede para o volume.

AcceptGrowCapacityPoolForShortTermCloneSplit

Enumeração

Ao dividir automaticamente o volume de clone de curto prazo, se o pool pai não tiver espaço suficiente para acomodar o volume após a divisão, ele será automaticamente redimensionado, o que levará a um aumento do faturamento. Para aceitar o crescimento automático do tamanho do pool de capacidade e criar um volume de clone de curto prazo, defina a propriedade como aceita.

Valor	Description
Accepted	O pool de capacidade de crescimento automático para divisão de clones de curto prazo é aceito.
Declined	O pool de capacidade de crescimento automático para divisão de clones de curto prazo é recusado. A criação de volume de clone de curto prazo não será permitida, para criar volume de clone de curto prazo aceitar pool de capacidade de crescimento automático.

ActualRansomwareProtectionState

Enumeração

O estado real do recurso Proteção Avançada contra Ransomware

Valor	Description
Disabled	A Proteção Avançada contra Ransomware está desativada
Enabled	A Proteção Avançada contra Ransomware está ativada
Learning	A Proteção Avançada contra Ransomware está em modo de aprendizagem
Paused	A Proteção Avançada contra Ransomware está em estado pausado

AvsDataStore

Enumeração

Especifica se o volume está habilitado para a finalidade do armazenamento de dados do Azure VMware Solution (AVS)

Valor	Description
Enabled	avsDataStore está ativado
Disabled	avsDataStore está desativado

ChownMode

Enumeração

Este parâmetro especifica quem está autorizado a alterar a propriedade de um arquivo. restricted - Somente o usuário root pode alterar a propriedade do arquivo. irrestrito - Usuários não-root podem alterar a propriedade dos arquivos que possuem.

Valor	Description
Restricted
Unrestricted

CoolAccessRetrievalPolicy

Enumeração

coolAccessRetrievalPolicy determina o comportamento de recuperação de dados da camada fria para o armazenamento padrão com base no padrão de leitura para volumes habilitados para acesso legal. Os valores possíveis para este campo são: Padrão - Os dados serão extraídos do nível legal para o armazenamento padrão em leituras aleatórias. Esta política é o padrão. OnRead - Toda a leitura de dados orientada pelo cliente é extraída do nível legal para o armazenamento padrão em leituras sequenciais e aleatórias. Nunca - Nenhum dado controlado pelo cliente é extraído do nível legal para o armazenamento padrão.

Valor	Description
Default
OnRead
Never

CoolAccessTieringPolicy

Enumeração

coolAccessTieringPolicy determina quais blocos de dados frios são movidos para a camada fria. Os valores possíveis para este campo são: Auto - Move blocos de dados frios do usuário nas cópias de instantâneo e no sistema de arquivos ativo para a camada legal. Esta política é o padrão. SnapshotOnly - Move os blocos de dados do usuário das cópias do Instantâneo de Volume que não estão associadas ao sistema de arquivos ativo para a camada legal.

Valor	Description
Auto
SnapshotOnly

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
User
Application
ManagedIdentity
Key

DesiredRansomwareProtectionState

Enumeração

O estado desejado do recurso Proteção Avançada contra Ransomware

Valor	Description
Disabled	A Proteção Avançada contra Ransomware está desativada
Enabled	A Proteção Avançada contra Ransomware está ativada

DestinationReplication

Object

Propriedades de replicação de destino

Name	Tipo	Description
region	string	A região remota para o volume de destino.
replicationType	ReplicationType	Indica se a replicação é entre zonas ou entre regiões.
resourceId	string (arm-id)	A ID do recurso do volume remoto
zone	string	A zona remota para o volume de destino.

EnableSubvolumes

Enumeração

Sinalizador que indica se as operações de subvolume estão habilitadas no volume

Valor	Description
Enabled	Os subvolumes estão habilitados
Disabled	Os subvolumes não estão habilitados

EncryptionKeySource

Enumeração

Origem da chave usada para criptografar dados em volume. Aplicável se a conta NetApp tiver encryption.keySource = 'Microsoft.KeyVault'. Os valores possíveis (sem distinção entre maiúsculas e minúsculas) são: 'Microsoft.NetApp, Microsoft.KeyVault'

Valor	Description
Microsoft.NetApp	Criptografia de chave gerenciada pela Microsoft
Microsoft.KeyVault	Criptografia de chave gerenciada pelo cliente

EndpointType

Enumeração

Indica se o volume local é a origem ou o destino da Replicação de Volume

Valor	Description
src
dst

ErrorAdditionalInfo

Object

O erro de gerenciamento de recursos informações adicionais.

Name	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Object

O detalhe do erro.

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	O erro informações adicionais.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Object

Resposta de erro

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

ExportPolicyRule

Object

Regra de Política de Exportação de Volume

Name	Tipo	Default value	Description
allowedClients	string		Especificação de entrada de cliente como cadeia de caracteres separada por vírgulas com CIDRs IPv4, endereços de host IPv4 e nomes de host
chownMode	ChownMode	Restricted	Este parâmetro especifica quem está autorizado a alterar a propriedade de um arquivo. restricted - Somente o usuário root pode alterar a propriedade do arquivo. irrestrito - Usuários não-root podem alterar a propriedade dos arquivos que possuem.
cifs	boolean		Permite o protocolo CIFS
hasRootAccess	boolean	True	Tem acesso root ao volume
kerberos5ReadOnly	boolean	False	Kerberos5 Acesso somente leitura. Para ser usado com a versão swagger 2020-05-01 ou posterior
kerberos5ReadWrite	boolean	False	Kerberos5 Acesso de leitura e gravação. Para ser usado com a versão swagger 2020-05-01 ou posterior
kerberos5iReadOnly	boolean	False	Acesso somente leitura Kerberos5i. Para ser usado com a versão swagger 2020-05-01 ou posterior
kerberos5iReadWrite	boolean	False	Kerberos5i Acesso de leitura e gravação. Para ser usado com a versão swagger 2020-05-01 ou posterior
kerberos5pReadOnly	boolean	False	Acesso somente leitura Kerberos5p. Para ser usado com a versão swagger 2020-05-01 ou posterior
kerberos5pReadWrite	boolean	False	Kerberos5p Acesso de leitura e gravação. Para ser usado com a versão swagger 2020-05-01 ou posterior
nfsv3	boolean		Permite o protocolo NFSv3. Habilitar somente para volumes do tipo NFSv3
nfsv41	boolean		Permite o protocolo NFSv4.1. Habilitar somente para volumes do tipo NFSv4.1
ruleIndex	integer (int32)		Índice de pedidos
unixReadOnly	boolean		Acesso somente leitura
unixReadWrite	boolean		Acesso de leitura e gravação

FileAccessLogs

Enumeração

Sinalizador que indica se os logs de acesso ao arquivo estão habilitados para o volume, com base nas configurações de diagnóstico ativas presentes no volume.

Valor	Description
Enabled	fileAccessLogs estão habilitados
Disabled	fileAccessLogs não estão habilitados

MountTargetProperties

Object

Propriedades de destino de montagem

Name	Tipo	Description
fileSystemId	string minLength: 36 maxLength: 36 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}$	UUID v4 usado para identificar o MountTarget
ipAddress	string	Endereço IPv4 do destino de montagem
mountTargetId	string minLength: 36 maxLength: 36 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}$	UUID v4 usado para identificar o MountTarget
smbServerFqdn	string	FQDN do nome de domínio totalmente qualificado do servidor SMB, FQDN

NetworkFeatures

Enumeração

Recursos de rede disponíveis para o volume ou estado atual da atualização.

Valor	Description
Basic	Recursos básicos de rede.
Standard	Recursos de rede padrão.
Basic_Standard	Atualização de recursos de rede básicos para padrão.
Standard_Basic	Atualização de recursos de rede Standard para Basic.

PlacementKeyValuePairs

Object

Parâmetros específicos de aplicação para a colocação de volumes no grupo de volumes

Name	Tipo	Description
key	string	Chave para um parâmetro específico do aplicativo para o posicionamento de volumes no grupo de volumes
value	string	Valor para um parâmetro específico do aplicativo para o posicionamento de volumes no grupo de volumes

RansomwareProtectionSettings

Object

Configurações de relatórios avançados de proteção contra ransomware (ARP)

Name	Tipo	Description
actualRansomwareProtectionState	ActualRansomwareProtectionState	O estado real do recurso Proteção Avançada contra Ransomware atualmente ativo no volume
desiredRansomwareProtectionState	DesiredRansomwareProtectionState	O valor desejado do estado do recurso Proteção Avançada contra Ransomware disponível para o volume

RemotePath

Object

O caminho completo para um volume que deve ser migrado para ANF. Necessário para volumes de migração

Name	Tipo	Description
externalHostName	string	O caminho para um host ONTAP
serverName	string	O nome de um servidor no host ONTAP
volumeName	string	O nome de um volume no servidor

ReplicationObject

Object

Propriedades de replicação

Name	Tipo	Description
destinationReplications	DestinationReplication[]	Uma lista de replicações de destino
endpointType	EndpointType	Indica se o volume local é a origem ou o destino da Replicação de Volume
remotePath	RemotePath	O caminho completo para um volume que deve ser migrado para ANF. Necessário para volumes de migração
remoteVolumeRegion	string	A região remota para a outra extremidade da Replicação de Volume.
remoteVolumeResourceId	string	A ID do recurso do volume remoto. Necessário para replicação entre regiões e entre zonas
replicationId	string	Id
replicationSchedule	ReplicationSchedule	Schedule

ReplicationSchedule

Enumeração

Schedule

Valor	Description
_10minutely
hourly
daily

ReplicationType

Enumeração

Indica se a replicação é entre zonas ou entre regiões.

Valor	Description
CrossRegionReplication	Replicação entre regiões
CrossZoneReplication	Replicação entre zonas

SecurityStyle

Enumeração

O estilo de segurança do volume, padrão unix, padrão para ntfs para protocolo duplo ou protocolo CIFS

Valor	Description
ntfs
unix

ServiceLevel

Enumeração

O nível de serviço do sistema de arquivos

Valor	Description
Standard	Nível de serviço padrão
Premium	Nível de serviço premium
Ultra	Nível de serviço ultra
StandardZRS	Nível de serviço de armazenamento redundante de zona. Isso será preterido em breve.
Flexible	Nível de serviço flexível

SmbAccessBasedEnumeration

Enumeração

Habilita a propriedade de compartilhamento de enumeração baseada em acesso para Compartilhamentos SMB. Aplicável apenas para volume SMB/DualProtocol

Valor	Description
Disabled	A configuração de compartilhamento smbAccessBasedEnumeration está desabilitada
Enabled	A configuração de compartilhamento smbAccessBasedEnumeration está habilitada

SmbNonBrowsable

Enumeração

Habilita a propriedade não navegável para Compartilhamentos SMB. Aplicável apenas para volume SMB/DualProtocol

Valor	Description
Disabled	A configuração de compartilhamento smbNonBrowsable está desabilitada
Enabled	A configuração de compartilhamento smbNonBrowsable está habilitada

systemData

Object

Metadados referentes à criação e última modificação do recurso.

Name	Tipo	Description
createdAt	string (date-time)	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.

Volume

Object

Recurso de volume

Name	Tipo	Default value	Description
etag	string		"Se o etag for fornecido no corpo da resposta, ele também pode ser fornecido como um cabeçalho de acordo com a convenção normal do etag. As tags de entidade são usadas para comparar duas ou mais entidades do mesmo recurso solicitado. HTTP/1.1 usa tags de entidade nos campos de cabeçalho etag (seção 14.19), If-Match (seção 14.24), If-None-Match (seção 14.26) e If-Range (seção 14.27).")
id	string (arm-id)		ID de recurso totalmente qualificado para o recurso. Por exemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location	string		A geolocalização onde o recurso vive
name	string		O nome do recurso
properties.acceptGrowCapacityPoolForShortTermCloneSplit	AcceptGrowCapacityPoolForShortTermCloneSplit		Ao dividir automaticamente o volume de clone de curto prazo, se o pool pai não tiver espaço suficiente para acomodar o volume após a divisão, ele será automaticamente redimensionado, o que levará a um aumento do faturamento. Para aceitar o crescimento automático do tamanho do pool de capacidade e criar um volume de clone de curto prazo, defina a propriedade como aceita.
properties.actualThroughputMibps	number (float)		Taxa de transferência real em MiB/s para volumes auto qosType calculados com base no tamanho e no nível de serviço
properties.avsDataStore	AvsDataStore	Disabled	Especifica se o volume está habilitado para a finalidade do armazenamento de dados do Azure VMware Solution (AVS)
properties.backupId	string (arm-id)		Identificador de recurso usado para identificar o backup.
properties.baremetalTenantId	string		Identificador Único de Inquilino Baremetal.
properties.capacityPoolResourceId	string		ID do recurso do pool usado no caso de criar um volume através do grupo de volumes
properties.cloneProgress	integer (int32)		Quando um volume estiver sendo restaurado a partir do instantâneo de outro volume, mostrará a porcentagem de conclusão desse processo de clonagem. Quando esse valor está vazio/nulo, não há nenhum processo de clonagem acontecendo atualmente neste volume. Esse valor será atualizado a cada 5 minutos durante a clonagem.
properties.coolAccess	boolean	False	Especifica se o Acesso Fresco (hierarquização) está habilitado para o volume.
properties.coolAccessRetrievalPolicy	CoolAccessRetrievalPolicy		coolAccessRetrievalPolicy determina o comportamento de recuperação de dados da camada fria para o armazenamento padrão com base no padrão de leitura para volumes habilitados para acesso legal. Os valores possíveis para este campo são: Padrão - Os dados serão extraídos do nível legal para o armazenamento padrão em leituras aleatórias. Esta política é o padrão. OnRead - Toda a leitura de dados orientada pelo cliente é extraída do nível legal para o armazenamento padrão em leituras sequenciais e aleatórias. Nunca - Nenhum dado controlado pelo cliente é extraído do nível legal para o armazenamento padrão.
properties.coolAccessTieringPolicy	CoolAccessTieringPolicy		coolAccessTieringPolicy determina quais blocos de dados frios são movidos para a camada fria. Os valores possíveis para este campo são: Auto - Move blocos de dados frios do usuário nas cópias de instantâneo e no sistema de arquivos ativo para a camada legal. Esta política é o padrão. SnapshotOnly - Move os blocos de dados do usuário das cópias do Instantâneo de Volume que não estão associadas ao sistema de arquivos ativo para a camada legal.
properties.coolnessPeriod	integer (int32) minimum: 2 maximum: 183		Especifica o número de dias após os quais os dados que não são acessados pelos clientes serão hierarquizados.
properties.creationToken	string minLength: 1 maxLength: 80 pattern: ^[a-zA-Z][a-zA-Z0-9\-]{0,79}$		Um caminho de arquivo exclusivo para o volume. Usado ao criar destinos de montagem
properties.dataProtection	VolumePropertiesDataProtection		Os volumes do tipo DataProtection incluem um objeto que contém detalhes da replicação
properties.dataStoreResourceId	string[]		Identificador exclusivo do recurso de armazenamento de dados
properties.defaultGroupQuotaInKiBs	integer (int64)	0	Cota de grupo padrão para volume em KiBs. Se isDefaultQuotaEnabled estiver definido, aplica-se o valor mínimo de 4 KiBs.
properties.defaultUserQuotaInKiBs	integer (int64)	0	Cota de usuário padrão para volume em KiBs. Se isDefaultQuotaEnabled estiver definido, aplica-se o valor mínimo de 4 KiBs.
properties.deleteBaseSnapshot	boolean		Se ativado (true), o instantâneo a partir do qual o volume foi criado será automaticamente excluído após a conclusão da operação de criação de volume. O padrão é false
properties.effectiveNetworkFeatures	NetworkFeatures	Basic	O valor efetivo do tipo de recursos de rede disponível para o volume ou o estado efetivo atual da atualização.
properties.enableSubvolumes	EnableSubvolumes	Disabled	Sinalizador que indica se as operações de subvolume estão habilitadas no volume
properties.encrypted	boolean		Especifica se o volume é criptografado ou não. Disponível apenas em volumes criados ou atualizados após 2022-01-01.
properties.encryptionKeySource	EncryptionKeySource	Microsoft.NetApp	Origem da chave usada para criptografar dados em volume. Aplicável se a conta NetApp tiver encryption.keySource = 'Microsoft.KeyVault'. Os valores possíveis (sem distinção entre maiúsculas e minúsculas) são: 'Microsoft.NetApp, Microsoft.KeyVault'
properties.exportPolicy	VolumePropertiesExportPolicy		Conjunto de regras da política de exportação
properties.fileAccessLogs	FileAccessLogs	Disabled	Sinalizador que indica se os logs de acesso ao arquivo estão habilitados para o volume, com base nas configurações de diagnóstico ativas presentes no volume.
properties.fileSystemId	string minLength: 36 maxLength: 36 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}$		Identificador exclusivo do sistema de arquivos.
properties.inheritedSizeInBytes	integer (int64)		Espaço compartilhado pelo volume de clone de curto prazo com o volume pai em bytes.
properties.isDefaultQuotaEnabled	boolean	False	Especifica se a cota padrão está habilitada para o volume.
properties.isLargeVolume	boolean	False	Especifica se o volume é um Volume Grande ou um Volume Regular.
properties.isRestoring	boolean		Restaurando
properties.kerberosEnabled	boolean	False	Descreva se um volume é KerberosEnabled. Para ser usado com a versão swagger 2020-05-01 ou posterior
properties.keyVaultPrivateEndpointResourceId	string		O ID de recurso do ponto de extremidade privado para KeyVault. Ele deve residir na mesma VNET que o volume. Aplicável apenas se encryptionKeySource = 'Microsoft.KeyVault'.
properties.ldapEnabled	boolean	False	Especifica se o LDAP está habilitado ou não para um determinado volume NFS.
properties.maximumNumberOfFiles	integer (int64)		Número máximo de ficheiros permitidos. Precisa de uma solicitação de serviço para ser alterado. Só é permitida a alteração se a quota de volume for superior a 4TiB.
properties.mountTargets	MountTargetProperties[]		Lista de alvos de montagem
properties.networkFeatures	NetworkFeatures	Basic	O valor original do tipo de recursos de rede disponível para o volume no momento em que foi criado.
properties.networkSiblingSetId	string minLength: 36 maxLength: 36 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}$		ID do Conjunto de Irmãos de Rede para o grupo de volumes que compartilham recursos de rede.
properties.originatingResourceId	string		Id do instantâneo ou backup a partir do qual o volume é restaurado.
properties.placementRules	PlacementKeyValuePairs[]		Regras de posicionamento específicas da aplicação para o volume específico
properties.protocolTypes	string[]		Conjunto de tipos de protocolo, NFSv3 padrão, CIFS para protocolo SMB
properties.provisionedAvailabilityZone	string		A zona de disponibilidade onde o volume é provisionado. Isto refere-se à zona de disponibilidade lógica onde o volume reside.
properties.provisioningState	string		Gerenciamento do ciclo de vida do Azure
properties.proximityPlacementGroup	string		Grupo de posicionamento de proximidade associado ao volume
properties.securityStyle	SecurityStyle	unix	O estilo de segurança do volume, padrão unix, padrão para ntfs para protocolo duplo ou protocolo CIFS
properties.serviceLevel	ServiceLevel	Premium	O nível de serviço do sistema de arquivos
properties.smbAccessBasedEnumeration	SmbAccessBasedEnumeration		Habilita a propriedade de compartilhamento de enumeração baseada em acesso para Compartilhamentos SMB. Aplicável apenas para volume SMB/DualProtocol
properties.smbContinuouslyAvailable	boolean	False	Permite a propriedade de compartilhamento continuamente disponível para o volume smb. Aplicável apenas ao volume SMB
properties.smbEncryption	boolean	False	Permite a criptografia para dados smb3 em voo. Aplicável apenas para o volume SMB/DualProtocol. Para ser usado com a versão swagger 2020-08-01 ou posterior
properties.smbNonBrowsable	SmbNonBrowsable		Habilita a propriedade não navegável para Compartilhamentos SMB. Aplicável apenas para volume SMB/DualProtocol
properties.snapshotDirectoryVisible	boolean	True	Se ativado (true), o volume conterá um diretório de instantâneo somente leitura que fornece acesso a cada um dos instantâneos do volume (o padrão é true).
properties.snapshotId	string (arm-id)		Identificador de recurso usado para identificar o instantâneo.
properties.storageToNetworkProximity	VolumeStorageToNetworkProximity		Fornece armazenamento para informações de proximidade de rede para o volume.
properties.subnetId	string		O URI de Recursos do Azure para uma sub-rede delegada. Deve ter a delegação Microsoft.NetApp/volumes
properties.t2Network	string		Informação da rede T2
properties.throughputMibps	number (float)		Taxa de transferência máxima em MiB/s que pode ser alcançada por este volume e isso será aceito como entrada apenas para o volume qosType manual
properties.unixPermissions	string minLength: 4 maxLength: 4		Permissões UNIX para volume NFS aceito no formato octal de 4 dígitos. O primeiro dígito seleciona os atributos set user ID(4), set group ID (2) e sticky (1). O segundo dígito seleciona a permissão para o proprietário do arquivo: ler (4), escrever (2) e executar (1). Terceiro seleciona permissões para outros usuários no mesmo grupo. o quarto para outros usuários que não fazem parte do grupo. 0755 - Dá permissões de leitura/gravação/execução para o proprietário e leitura/execução para o grupo e outros usuários.
properties.usageThreshold	integer (int64) minimum: 53687091200 maximum: 2638827906662400	0	Cota máxima de armazenamento permitida para um sistema de arquivos em bytes. Esta é uma cota flexível usada apenas para alertas. Para volumes regulares, os valores válidos estão na faixa de 50GiB a 100TiB. Para grandes volumes, os valores válidos estão na faixa de 100TiB a 500TiB e, em caráter excecional, de 2400GiB a 2400TiB. Valores expressos em bytes como múltiplos de 1 GiB.
properties.volumeGroupName	string		Nome do Grupo de Volumes
properties.volumeSpecName	string		Nome da especificação do volume é a designação ou identificador específico do aplicativo para o volume específico em um grupo de volumes para, por exemplo, dados, log
properties.volumeType	string		Que tipo de volume é esse. Para volumes de destino em Replicação entre regiões, defina type como DataProtection. Para criar volume de clone, defina type como ShortTermClone
systemData	systemData		Metadados do Azure Resource Manager contendo informações createdBy e modifiedBy.
tags	object		Tags de recursos.
type	string		O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"
zones	string[]		As zonas de disponibilidade.

VolumeBackupProperties

Object

Propriedades de backup de volume

Name	Tipo	Description
backupPolicyId	string (arm-id)	ID do recurso da política de backup
backupVaultId	string (arm-id)	ID do recurso do cofre de backup
policyEnforced	boolean	Política aplicada

VolumePropertiesDataProtection

Object

Os volumes do tipo DataProtection incluem um objeto que contém detalhes da replicação

Name	Tipo	Description
backup	VolumeBackupProperties	Propriedades de backup
ransomwareProtection	RansomwareProtectionSettings	Configurações avançadas de proteção contra ransomware
replication	ReplicationObject	Propriedades de replicação
snapshot	VolumeSnapshotProperties	Propriedades do instantâneo.
volumeRelocation	VolumeRelocationProperties	Propriedades VolumeRelocation

VolumePropertiesExportPolicy

Object

Conjunto de regras da política de exportação

Name	Tipo	Description
rules	ExportPolicyRule[]	Regra de política de exportação

VolumeRelocationProperties

Object

Propriedades de realocação de volume

Name	Tipo	Description
readyToBeFinalized	boolean	Tem realocação concluída e está pronto para ser limpo
relocationRequested	boolean	Foi solicitada a recolocação para este volume

VolumeSnapshotProperties

Object

Propriedades do instantâneo de volume

Name	Tipo	Description
snapshotPolicyId	string	ResourceId da Política de Snapshot

VolumeStorageToNetworkProximity

Enumeração

Fornece armazenamento para informações de proximidade de rede para o volume.

Valor	Description
Default	Armazenamento básico para conectividade de rede.
T1	Armazenamento T1 padrão para conectividade de rede.
T2	Armazenamento T2 padrão para conectividade de rede.
AcrossT2	Armazenamento AcrossT2 padrão para conectividade de rede.