File Shares - List

Seznamy všechny sdílené složky.

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}

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
accountName
path True

string

Název účtu úložiště v zadané skupině prostředků. Názvy účtů úložiště musí mít délku 3 až 24 znaků a musí obsahovat jenom číslice a malá písmena.

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

resourceGroupName
path True

string

Název skupiny prostředků v rámci předplatného uživatele. V názvu se rozlišují malá a velká písmena.

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

subscriptionId
path True

string

ID cílového předplatného.

api-version
query True

string

Verze rozhraní API, která se má použít pro tuto operaci.

$expand
query

string

Volitelné, slouží k rozbalení vlastností ve vlastnostech sdílené složky. Platné hodnoty jsou: odstraněno, snímky. Měl by být předán jako řetězec s oddělovačem ','.

$filter
query

string

Nepovinný parametr. Pokud je zadáno, zobrazí se pouze názvy sdílených složek začínající filtrem.

$maxpagesize
query

string

Nepovinný parametr. Zadaný maximální počet sdílených složek, které lze zahrnout do seznamu.

Odpovědi

Name Typ Description
200 OK

FileShareItems

OK – Operace výpisu sdílených složek byla úspěšně dokončena.

Other Status Codes

CloudError

Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

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

Scopes

Name Description
user_impersonation zosobnění uživatelského účtu

Příklady

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"
      }
    }
  ]
}

Definice

Name Description
AccessPolicy
CloudError

Chybová odpověď ze služby Storage.

CloudErrorBody

Chybová odpověď ze služby Storage.

EnabledProtocols

Ověřovací protokol, který se používá pro sdílenou složku. Lze zadat pouze při vytváření sdílené složky.

FileShareItem

Vlastnosti sdílené složky budou uvedeny.

FileShareItems

Schéma odpovědi. Obsahuje seznam vrácených sdílených složek a pokud je stránkování požadováno nebo povinné, adresu URL na další stránku sdílených složek.

LeaseDuration

Určuje, zda má zapůjčení sdílené složky neomezenou nebo pevnou dobu trvání, pouze pokud je sdílená složka zapůjčena.

LeaseState

Stav zapůjčení sdílené složky

LeaseStatus

Stav zapůjčení sdílené složky

RootSquashType

Vlastnost je určena pouze pro sdílenou složku SYSTÉMU SOUBORŮ NFS. Výchozí hodnota je NoRootSquash.

ShareAccessTier

Úroveň přístupu pro konkrétní sdílenou složku. Účet GpV2 si může vybrat mezi TransactionOptimized (výchozí), Horkou a Studenou. Účet FileStorage může zvolit Premium.

SignedIdentifier

AccessPolicy

Name Typ Description
expiryTime

string

Doba vypršení platnosti zásad přístupu

permission

string

Seznam zkrácených oprávnění

startTime

string

Počáteční čas zásad přístupu

CloudError

Chybová odpověď ze služby Storage.

Name Typ Description
error

CloudErrorBody

Chybová odpověď ze služby Storage.

CloudErrorBody

Chybová odpověď ze služby Storage.

Name Typ Description
code

string

Identifikátor chyby. Kódy jsou invariantní a mají být využívány programově.

details

CloudErrorBody[]

Seznam dalších podrobností o chybě

message

string

Zpráva popisující chybu, která má být vhodná pro zobrazení v uživatelském rozhraní.

target

string

Cíl konkrétní chyby. Například název vlastnosti v chybě.

EnabledProtocols

Ověřovací protokol, který se používá pro sdílenou složku. Lze zadat pouze při vytváření sdílené složky.

Name Typ Description
NFS

string

SMB

string

FileShareItem

Vlastnosti sdílené složky budou uvedeny.

Name Typ Description
etag

string

Značka prostředku Etag.

id

string

Plně kvalifikované ID prostředku. Příklad – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

Název prostředku

properties.accessTier

ShareAccessTier

Úroveň přístupu pro konkrétní sdílenou složku. Účet GpV2 si může vybrat mezi TransactionOptimized (výchozí), Horkou a Studenou. Účet FileStorage může zvolit Premium.

properties.accessTierChangeTime

string

Označuje čas poslední změny úrovně přístupu ke sdílené složce.

properties.accessTierStatus

string

Označuje, jestli existuje čekající přechod na úroveň přístupu.

properties.deleted

boolean

Označuje, jestli byla sdílená složka odstraněna.

properties.deletedTime

string

Čas odstranění sdílené složky.

properties.enabledProtocols

EnabledProtocols

Ověřovací protokol, který se používá pro sdílenou složku. Lze zadat pouze při vytváření sdílené složky.

properties.lastModifiedTime

string

Vrátí datum a čas poslední změny sdílené složky.

properties.leaseDuration

LeaseDuration

Určuje, zda má zapůjčení sdílené složky neomezenou nebo pevnou dobu trvání, pouze pokud je sdílená složka zapůjčena.

properties.leaseState

LeaseState

Stav zapůjčení sdílené složky

properties.leaseStatus

LeaseStatus

Stav zapůjčení sdílené složky

properties.metadata

object

Pár název-hodnota, který se přidruží ke sdílené složce jako metadata.

properties.remainingRetentionDays

integer

Zbývající dny uchovávání pro sdílenou složku, která byla odstraněna obnovitelně.

properties.rootSquash

RootSquashType

Vlastnost je určena pouze pro sdílenou složku SYSTÉMU SOUBORŮ NFS. Výchozí hodnota je NoRootSquash.

properties.shareQuota

integer

Maximální velikost sdílené složky v gigabajtech. Musí být větší než 0 a menší nebo rovno 5 TB (5120). U velkých sdílených složek je maximální velikost 102400.

properties.shareUsageBytes

integer

Přibližná velikost dat uložených ve sdílené složce Všimněte si, že tato hodnota nemusí zahrnovat všechny nedávno vytvořené soubory nebo soubory s nedávno změněnou velikostí.

properties.signedIdentifiers

SignedIdentifier[]

Seznam uložených zásad přístupu zadaných ve sdílené složce

properties.snapshotTime

string

Čas vytvoření snímku sdílené složky vrácený v odpovědi sdílených složek seznamu s rozbalením parametru "snímky".

properties.version

string

Verze sdílené složky.

type

string

Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

FileShareItems

Schéma odpovědi. Obsahuje seznam vrácených sdílených složek a pokud je stránkování požadováno nebo povinné, adresu URL na další stránku sdílených složek.

Name Typ Description
nextLink

string

Adresa URL požadavku, která se dá použít k dotazování na další stránku sdílených složek. Vrátí se, když celkový počet požadovaných sdílených složek překročí maximální velikost stránky.

value

FileShareItem[]

Seznam vrácených sdílených složek

LeaseDuration

Určuje, zda má zapůjčení sdílené složky neomezenou nebo pevnou dobu trvání, pouze pokud je sdílená složka zapůjčena.

Name Typ Description
Fixed

string

Infinite

string

LeaseState

Stav zapůjčení sdílené složky

Name Typ Description
Available

string

Breaking

string

Broken

string

Expired

string

Leased

string

LeaseStatus

Stav zapůjčení sdílené složky

Name Typ Description
Locked

string

Unlocked

string

RootSquashType

Vlastnost je určena pouze pro sdílenou složku SYSTÉMU SOUBORŮ NFS. Výchozí hodnota je NoRootSquash.

Name Typ Description
AllSquash

string

NoRootSquash

string

RootSquash

string

ShareAccessTier

Úroveň přístupu pro konkrétní sdílenou složku. Účet GpV2 si může vybrat mezi TransactionOptimized (výchozí), Horkou a Studenou. Účet FileStorage může zvolit Premium.

Name Typ Description
Cool

string

Hot

string

Premium

string

TransactionOptimized

string

SignedIdentifier

Name Typ Description
accessPolicy

AccessPolicy

Zásady přístupu

id

string

Jedinečný identifikátor uložených zásad přístupu.