File Shares - List

Listas todos os compartilhamentos.

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 de URI

Nome Em Obrigatório Tipo Description
accountName
path True

string

O nome da conta de armazenamento dentro do grupo de recursos especificado. Os nomes da conta de armazenamento devem ter entre 3 e 24 caracteres, usar números e apenas letras minúsculas.

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

resourceGroupName
path True

string

O nome do grupo de recursos na assinatura do usuário. O nome diferencia maiúsculas de minúsculas.

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

subscriptionId
path True

string

A ID da assinatura de destino.

api-version
query True

string

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

$expand
query

string

Opcional, usado para expandir as propriedades dentro das propriedades do compartilhamento. Os valores válidos são: excluídos, instantâneos. Deve ser passada como uma cadeia de caracteres com delimitador '',

$filter
query

string

Opcional. Quando especificado, somente os nomes de compartilhamento começando com o filtro serão listados.

$maxpagesize
query

string

Opcional. Número máximo especificado de compartilhamentos que podem ser incluídos na lista.

Respostas

Nome Tipo Description
200 OK

FileShareItems

OK -- A operação Listar Compartilhamentos foi concluída com êxito.

Other Status Codes

CloudError

Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory

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

Scopes

Nome Description
user_impersonation representar sua conta de usuário

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

Nome 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 usado para o compartilhamento de arquivos. Só pode ser especificado ao criar um compartilhamento.

FileShareItem

As propriedades de compartilhamento de arquivo serão listadas.

FileShareItems

Esquema de resposta. Contém a lista de compartilhamentos retornados e, se a paginação for solicitada ou necessária, uma URL para a próxima página de compartilhamentos.

LeaseDuration

Especifica se a concessão em um compartilhamento é de duração infinita ou fixa, somente quando o compartilhamento é concedido.

LeaseState

Estado de concessão do compartilhamento.

LeaseStatus

O status de concessão do compartilhamento.

RootSquashType

A propriedade é somente para compartilhamento NFS. O padrão é NoRootSquash.

ShareAccessTier

Camada de acesso para compartilhamento específico. A conta gpV2 pode escolher entre TransactionOptimized (padrão), Hot e Cool. A conta FileStorage pode escolher Premium.

SignedIdentifier

AccessPolicy

Nome Tipo Description
expiryTime

string

Hora 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.

Nome Tipo Description
error

CloudErrorBody

Uma resposta de erro do serviço de Armazenamento.

CloudErrorBody

Uma resposta de erro do serviço de Armazenamento.

Nome Tipo Description
code

string

Um identificador para o erro. Os códigos são invariáveis e devem 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 exibição em uma interface do usuário.

target

string

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

EnabledProtocols

O protocolo de autenticação usado para o compartilhamento de arquivos. Só pode ser especificado ao criar um compartilhamento.

Nome Tipo Description
NFS

string

SMB

string

FileShareItem

As propriedades de compartilhamento de arquivo serão listadas.

Nome Tipo Description
etag

string

Etag de recurso.

id

string

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

name

string

O nome do recurso

properties.accessTier

ShareAccessTier

Camada de acesso para compartilhamento específico. A conta gpV2 pode escolher entre TransactionOptimized (padrão), Hot e Cool. A conta FileStorage pode escolher Premium.

properties.accessTierChangeTime

string

Indica o último tempo de modificação para a camada de acesso de compartilhamento.

properties.accessTierStatus

string

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

properties.deleted

boolean

Indica se o compartilhamento foi excluído.

properties.deletedTime

string

O tempo excluído se o compartilhamento foi excluído.

properties.enabledProtocols

EnabledProtocols

O protocolo de autenticação usado para o compartilhamento de arquivos. Só pode ser especificado ao criar um compartilhamento.

properties.lastModifiedTime

string

Retorna a data e a hora em que o compartilhamento foi modificado pela última vez.

properties.leaseDuration

LeaseDuration

Especifica se a concessão em um compartilhamento é de duração infinita ou fixa, somente quando o compartilhamento é concedido.

properties.leaseState

LeaseState

Estado de concessão do compartilhamento.

properties.leaseStatus

LeaseStatus

O status de concessão do compartilhamento.

properties.metadata

object

Um par de nome-valor a ser associado ao compartilhamento como metadados.

properties.remainingRetentionDays

integer

Dias de retenção restantes para o compartilhamento que foi excluído temporariamente.

properties.rootSquash

RootSquashType

A propriedade é somente para compartilhamento NFS. O padrão é NoRootSquash.

properties.shareQuota

integer

O tamanho máximo do compartilhamento, em gigabytes. Deve ser maior que 0 e menor ou igual a 5 TB (5120). Para Compartilhamentos de Arquivos Grandes, o tamanho máximo é 102400.

properties.shareUsageBytes

integer

O tamanho aproximado dos dados armazenados no compartilhamento. Observe que esse valor pode não incluir todos os arquivos recém-criados ou redimensionados recentemente.

properties.signedIdentifiers

SignedIdentifier[]

Lista de políticas de acesso armazenadas especificadas no compartilhamento.

properties.snapshotTime

string

O tempo de criação do compartilhamento instantâneo retornado na resposta de compartilhamentos de lista com expandir o parâmetro "instantâneos".

properties.version

string

A versão do compartilhamento.

type

string

Tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

FileShareItems

Esquema de resposta. Contém a lista de compartilhamentos retornados e, se a paginação for solicitada ou necessária, uma URL para a próxima página de compartilhamentos.

Nome Tipo Description
nextLink

string

URL de solicitação que pode ser usada para consultar a próxima página de compartilhamentos. Retornado quando o número total de compartilhamentos solicitados excede o tamanho máximo da página.

value

FileShareItem[]

Lista de compartilhamentos de arquivos retornados.

LeaseDuration

Especifica se a concessão em um compartilhamento é de duração infinita ou fixa, somente quando o compartilhamento é concedido.

Nome Tipo Description
Fixed

string

Infinite

string

LeaseState

Estado de concessão do compartilhamento.

Nome Tipo Description
Available

string

Breaking

string

Broken

string

Expired

string

Leased

string

LeaseStatus

O status de concessão do compartilhamento.

Nome Tipo Description
Locked

string

Unlocked

string

RootSquashType

A propriedade é somente para compartilhamento NFS. O padrão é NoRootSquash.

Nome Tipo Description
AllSquash

string

NoRootSquash

string

RootSquash

string

ShareAccessTier

Camada de acesso para compartilhamento específico. A conta gpV2 pode escolher entre TransactionOptimized (padrão), Hot e Cool. A conta FileStorage pode escolher Premium.

Nome Tipo Description
Cool

string

Hot

string

Premium

string

TransactionOptimized

string

SignedIdentifier

Nome Tipo Description
accessPolicy

AccessPolicy

Política de acesso

id

string

Um identificador exclusivo da política de acesso armazenada.