Share via


File Shares - List

Listas todas as acções.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/fileServices/default/shares?api-version=2023-01-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/fileServices/default/shares?api-version=2023-01-01&$maxpagesize={$maxpagesize}&$filter={$filter}&$expand={$expand}

Parâmetros do URI

Name Em Necessário Tipo Description
accountName
path True

string

O nome da conta de armazenamento no grupo de recursos especificado. Os nomes das contas de armazenamento têm de ter entre 3 e 24 carateres de comprimento e utilizar apenas números e letras minúsculas.

Regex pattern: ^[a-z0-9]+$

resourceGroupName
path True

string

O nome do grupo de recursos na subscrição do utilizador. O nome não é sensível a maiúsculas e minúsculas.

Regex pattern: ^[-\w\._\(\)]+$

subscriptionId
path True

string

O ID da subscrição de destino.

api-version
query True

string

A versão da API a utilizar para esta operação.

$expand
query

string

Opcional, utilizado para expandir as propriedades nas propriedades da partilha. Os valores válidos são: eliminados, instantâneos. Deve ser transmitido como uma cadeia com o delimitador ','

$filter
query

string

Opcional. Quando especificado, apenas os nomes de partilha que começam com o filtro serão listados.

$maxpagesize
query

string

Opcional. Foi especificado o número máximo de partilhas que podem ser incluídas na lista.

Respostas

Name Tipo Description
200 OK

FileShareItems

OK -- Operação de Partilhas de Lista concluída com êxito.

Other Status Codes

CloudError

Resposta de erro que descreve a razão pela qual a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation representar a sua conta de utilizador

Exemplos

ListDeletedShares
ListShares
ListShareSnapshots

ListDeletedShares

Sample Request

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/res9290/providers/Microsoft.Storage/storageAccounts/sto1590/fileServices/default/shares?api-version=2023-01-01&$expand=deleted

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/{subscription-id}/resourceGroups/res9290/providers/Microsoft.Storage/storageAccounts/sto1590/fileServices/default/shares/share1644_1234567890",
      "name": "share1644",
      "type": "Microsoft.Storage/storageAccounts/fileServices/shares",
      "etag": "\"0x8D589847D51C7DE\"",
      "properties": {
        "lastModifiedTime": "2019-05-14T08:20:47Z",
        "shareQuota": 1024,
        "version": "1234567890",
        "deleted": true,
        "deletedTime": "2019-12-14T08:20:47Z",
        "remainingRetentionDays": 30
      }
    },
    {
      "id": "/subscriptions/{subscription-id}/resourceGroups/res9290/providers/Microsoft.Storage/storageAccounts/sto1590/fileServices/default/shares/share4052",
      "name": "share4052",
      "type": "Microsoft.Storage/storageAccounts/fileServices/shares",
      "etag": "\"0x8D589847DAB5AF9\"",
      "properties": {
        "lastModifiedTime": "2019-05-14T08:20:47Z",
        "shareQuota": 1024
      }
    }
  ]
}

ListShares

Sample Request

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/res9290/providers/Microsoft.Storage/storageAccounts/sto1590/fileServices/default/shares?api-version=2023-01-01

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/{subscription-id}/resourceGroups/res9290/providers/Microsoft.Storage/storageAccounts/sto1590/fileServices/default/shares/share1644",
      "name": "share1644",
      "type": "Microsoft.Storage/storageAccounts/fileServices/shares",
      "etag": "\"0x8D589847D51C7DE\"",
      "properties": {
        "lastModifiedTime": "2019-05-14T08:20:47Z",
        "shareQuota": 1024
      }
    },
    {
      "id": "/subscriptions/{subscription-id}/resourceGroups/res9290/providers/Microsoft.Storage/storageAccounts/sto1590/fileServices/default/shares/share4052",
      "name": "share4052",
      "type": "Microsoft.Storage/storageAccounts/fileServices/shares",
      "etag": "\"0x8D589847DAB5AF9\"",
      "properties": {
        "lastModifiedTime": "2019-05-14T08:20:47Z",
        "shareQuota": 1024
      }
    }
  ],
  "nextLink": "https://sto1590endpoint/subscriptions/{subscription-id}/resourceGroups/res9290/providers/Microsoft.Storage/storageAccounts/sto1590/fileServices/default/shares?api-version=2022-09-01&$maxpagesize=2&$skipToken=/sto1590/share5103"
}

ListShareSnapshots

Sample Request

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/res9290/providers/Microsoft.Storage/storageAccounts/sto1590/fileServices/default/shares?api-version=2023-01-01&$expand=snapshots

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/{subscription-id}/resourceGroups/res9290/providers/Microsoft.Storage/storageAccounts/sto1590/fileServices/default/shares/share4052",
      "name": "share4052",
      "type": "Microsoft.Storage/storageAccounts/fileServices/shares",
      "etag": "\"0x8D589847DAB5AF9\"",
      "properties": {
        "lastModifiedTime": "2020-10-26T05:47:05.0000000Z",
        "shareQuota": 1024
      }
    },
    {
      "id": "/subscriptions/{subscription-id}/resourceGroups/res9290/providers/Microsoft.Storage/storageAccounts/sto1590/fileServices/default/shares/share4052",
      "name": "share4052",
      "type": "Microsoft.Storage/storageAccounts/fileServices/shares",
      "etag": "\"0x8D589847DAB5AF9\"",
      "properties": {
        "lastModifiedTime": "2020-10-26T05:47:05.0000000Z",
        "shareQuota": 1024,
        "snapshotTime": "2020-10-26T05:48:07.0000000Z"
      }
    }
  ]
}

Definições

Name Description
AccessPolicy
CloudError

Uma resposta de erro do serviço de Armazenamento.

CloudErrorBody

Uma resposta de erro do serviço de Armazenamento.

EnabledProtocols

O protocolo de autenticação que é utilizado para a partilha de ficheiros. Só pode ser especificado ao criar uma partilha.

FileShareItem

As propriedades da partilha de ficheiros estão listadas.

FileShareItems

Esquema de resposta. Contém uma lista de partilhas devolvidas e, se a paginação for pedida ou necessária, um URL para a página seguinte das partilhas.

LeaseDuration

Especifica se a concessão de uma partilha é de duração infinita ou fixa, apenas quando a partilha é arrendada.

LeaseState

Estado de concessão da partilha.

LeaseStatus

O estado da concessão da partilha.

RootSquashType

A propriedade destina-se apenas à partilha NFS. A predefinição é NoRootSquash.

ShareAccessTier

Escalão de acesso para partilha específica. A conta GpV2 pode escolher entre TransactionOptimized (predefinição), Hot e Cool. A conta FileStorage pode escolher Premium.

SignedIdentifier

AccessPolicy

Name Tipo Description
expiryTime

string

Tempo de expiração da política de acesso

permission

string

Lista de permissões abreviadas.

startTime

string

Hora de início da política de acesso

CloudError

Uma resposta de erro do serviço de Armazenamento.

Name Tipo Description
error

CloudErrorBody

Uma resposta de erro do serviço de Armazenamento.

CloudErrorBody

Uma resposta de erro do serviço de Armazenamento.

Name Tipo Description
code

string

Um identificador para o erro. Os códigos são invariantes e destinam-se a ser consumidos programaticamente.

details

CloudErrorBody[]

Uma lista de detalhes adicionais sobre o erro.

message

string

Uma mensagem que descreve o erro, destinada a ser adequada para ser apresentada numa interface de utilizador.

target

string

O destino do erro específico. Por exemplo, o nome da propriedade em erro.

EnabledProtocols

O protocolo de autenticação que é utilizado para a partilha de ficheiros. Só pode ser especificado ao criar uma partilha.

Name Tipo Description
NFS

string

SMB

string

FileShareItem

As propriedades da partilha de ficheiros estão listadas.

Name Tipo Description
etag

string

Resource Etag.

id

string

ID de recurso completamente qualificado para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

O nome do recurso

properties.accessTier

ShareAccessTier

Escalão de acesso para partilha específica. A conta GpV2 pode escolher entre TransactionOptimized (predefinição), Hot e Cool. A conta FileStorage pode escolher Premium.

properties.accessTierChangeTime

string

Indica a última hora de modificação para partilhar a camada de acesso.

properties.accessTierStatus

string

Indica se existe uma transição pendente para a camada de acesso.

properties.deleted

boolean

Indica se a partilha foi eliminada.

properties.deletedTime

string

A hora eliminada se a partilha tiver sido eliminada.

properties.enabledProtocols

EnabledProtocols

O protocolo de autenticação que é utilizado para a partilha de ficheiros. Só pode ser especificado ao criar uma partilha.

properties.lastModifiedTime

string

Devolve a data e hora em que a partilha foi modificada pela última vez.

properties.leaseDuration

LeaseDuration

Especifica se a concessão de uma partilha é de duração infinita ou fixa, apenas quando a partilha é arrendada.

properties.leaseState

LeaseState

Estado de concessão da partilha.

properties.leaseStatus

LeaseStatus

O estado da concessão da partilha.

properties.metadata

object

Um par name-value para associar à partilha como metadados.

properties.remainingRetentionDays

integer

Dias de retenção restantes para a partilha que foi eliminada de forma recuperável.

properties.rootSquash

RootSquashType

A propriedade destina-se apenas à partilha NFS. A predefinição é NoRootSquash.

properties.shareQuota

integer

O tamanho máximo da partilha, em gigabytes. Tem de ser maior que 0 e menor ou igual a 5 TB (5120). Para Partilhas de Ficheiros Grandes, o tamanho máximo é 102400.

properties.shareUsageBytes

integer

O tamanho aproximado dos dados armazenados na partilha. Tenha em atenção que este valor pode não incluir todos os ficheiros recentemente criados ou redimensionados recentemente.

properties.signedIdentifiers

SignedIdentifier[]

Lista de políticas de acesso armazenado especificadas na partilha.

properties.snapshotTime

string

Tempo de criação do instantâneo de partilha devolvido na resposta das partilhas de lista com "instantâneos" de expansão do parâmetro.

properties.version

string

A versão da partilha.

type

string

O tipo de recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

FileShareItems

Esquema de resposta. Contém uma lista de partilhas devolvidas e, se a paginação for pedida ou necessária, um URL para a página seguinte das partilhas.

Name Tipo Description
nextLink

string

URL do pedido que pode ser utilizado para consultar a página seguinte das partilhas. Devolvido quando o número total de partilhas pedidas exceder o tamanho máximo da página.

value

FileShareItem[]

Lista de partilhas de ficheiros devolvidas.

LeaseDuration

Especifica se a concessão de uma partilha é de duração infinita ou fixa, apenas quando a partilha é arrendada.

Name Tipo Description
Fixed

string

Infinite

string

LeaseState

Estado de concessão da partilha.

Name Tipo Description
Available

string

Breaking

string

Broken

string

Expired

string

Leased

string

LeaseStatus

O estado da concessão da partilha.

Name Tipo Description
Locked

string

Unlocked

string

RootSquashType

A propriedade destina-se apenas à partilha NFS. A predefinição é NoRootSquash.

Name Tipo Description
AllSquash

string

NoRootSquash

string

RootSquash

string

ShareAccessTier

Escalão de acesso para partilha específica. A conta GpV2 pode escolher entre TransactionOptimized (predefinição), Hot e Cool. A conta FileStorage pode escolher Premium.

Name Tipo Description
Cool

string

Hot

string

Premium

string

TransactionOptimized

string

SignedIdentifier

Name Tipo Description
accessPolicy

AccessPolicy

Política de acesso

id

string

Um identificador exclusivo da política de acesso armazenado.