File Shares - List

Listen alle Freigaben.

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}

URI-Parameter

Name In Erforderlich Typ Beschreibung
accountName
path True

string

Der Name des Speicherkontos innerhalb der angegebenen Ressourcengruppe. Speicherkontonamen müssen zwischen 3 und 24 Zeichen lang sein und dürfen nur Zahlen und Kleinbuchstaben enthalten.

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

resourceGroupName
path True

string

Der Name der Ressourcengruppe im Abonnement des Benutzers. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

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

subscriptionId
path True

string

Hierbei handelt es sich um die ID des Zielabonnements.

api-version
query True

string

Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

$expand
query

string

Optional, wird verwendet, um die Eigenschaften innerhalb der Eigenschaften der Freigabe zu erweitern. Gültige Werte sind: gelöscht, Momentaufnahmen. Sollte als Zeichenfolge mit dem Trennzeichen "," übergeben werden.

$filter
query

string

Optional. Wenn angegeben, werden nur Freigabenamen aufgeführt, die mit dem Filter beginnen.

$maxpagesize
query

string

Optional. Gibt die maximale Anzahl von Freigaben an, die in die Liste aufgenommen werden können.

Antworten

Name Typ Beschreibung
200 OK

FileShareItems

OK : Der Vorgang "Listenfreigaben" wurde erfolgreich abgeschlossen.

Other Status Codes

CloudError

Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

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

Scopes

Name Beschreibung
user_impersonation Identitätswechsel Ihres Benutzerkontos

Beispiele

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

Definitionen

Name Beschreibung
AccessPolicy
CloudError

Eine Fehlerantwort des Speicherdiensts.

CloudErrorBody

Eine Fehlerantwort des Speicherdiensts.

EnabledProtocols

Das Authentifizierungsprotokoll, das für die Dateifreigabe verwendet wird. Kann nur beim Erstellen einer Freigabe angegeben werden.

FileShareItem

Die Dateifreigabeeigenschaften werden aufgelistet.

FileShareItems

Antwortschema. Enthält eine Liste der zurückgegebenen Freigaben und eine URL zur nächsten Seite von Freigaben, wenn paging angefordert oder erforderlich ist.

LeaseDuration

Gibt an, ob die Lease für eine Freigabe von unendlicher oder fester Dauer ist, nur wenn die Freigabe geleast wird.

LeaseState

Leasestatus der Aktie.

LeaseStatus

Die Lease-status der Aktie.

RootSquashType

Die Eigenschaft gilt nur für die NFS-Freigabe. Der Standardwert ist NoRootSquash.

ShareAccessTier

Zugriffsebene für eine bestimmte Freigabe. GpV2-Konto kann zwischen TransactionOptimized (Standard), Hot und Cool wählen. Das FileStorage-Konto kann Premium auswählen.

SignedIdentifier

AccessPolicy

Name Typ Beschreibung
expiryTime

string

Ablaufzeit der Zugriffsrichtlinie

permission

string

Liste der abgekürzten Berechtigungen.

startTime

string

Startzeit der Zugriffsrichtlinie

CloudError

Eine Fehlerantwort des Speicherdiensts.

Name Typ Beschreibung
error

CloudErrorBody

Eine Fehlerantwort des Speicherdiensts.

CloudErrorBody

Eine Fehlerantwort des Speicherdiensts.

Name Typ Beschreibung
code

string

Ein Bezeichner für den Fehler. Codes sind unveränderlich und sollten programmgesteuert verwendet werden.

details

CloudErrorBody[]

Eine Liste mit zusätzlichen Details zum Fehler.

message

string

Eine Meldung, die den Fehler beschreibt, der für die Anzeige in einer Benutzeroberfläche geeignet sein soll.

target

string

Das Ziel des jeweiligen Fehlers. Beispiel: Der Name der -Eigenschaft im Fehler.

EnabledProtocols

Das Authentifizierungsprotokoll, das für die Dateifreigabe verwendet wird. Kann nur beim Erstellen einer Freigabe angegeben werden.

Name Typ Beschreibung
NFS

string

SMB

string

FileShareItem

Die Dateifreigabeeigenschaften werden aufgelistet.

Name Typ Beschreibung
etag

string

Ressourcen-Etag.

id

string

Vollqualifizierte Ressourcen-ID für die Ressource. Beispiel: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

Der Name der Ressource

properties.accessTier

ShareAccessTier

Zugriffsebene für eine bestimmte Freigabe. GpV2-Konto kann zwischen TransactionOptimized (Standard), Hot und Cool wählen. Das FileStorage-Konto kann Premium auswählen.

properties.accessTierChangeTime

string

Gibt den Zeitpunkt der letzten Änderung für die Freigabezugriffsebene an.

properties.accessTierStatus

string

Gibt an, ob ein Übergang für die Zugriffsebene aussteht.

properties.deleted

boolean

Gibt an, ob die Freigabe gelöscht wurde.

properties.deletedTime

string

Der gelöschte Zeitpunkt, wenn die Freigabe gelöscht wurde.

properties.enabledProtocols

EnabledProtocols

Das Authentifizierungsprotokoll, das für die Dateifreigabe verwendet wird. Kann nur beim Erstellen einer Freigabe angegeben werden.

properties.lastModifiedTime

string

Gibt das Datum und die Uhrzeit der letzten Änderung der Freigabe zurück.

properties.leaseDuration

LeaseDuration

Gibt an, ob die Lease für eine Freigabe von unendlicher oder fester Dauer ist, nur wenn die Freigabe geleast wird.

properties.leaseState

LeaseState

Leasestatus der Aktie.

properties.leaseStatus

LeaseStatus

Die Lease-status der Aktie.

properties.metadata

object

Ein Name-Wert-Paar, das der Freigabe als Metadaten zugeordnet wird.

properties.remainingRetentionDays

integer

Verbleibende Aufbewahrungstage für freigaben, die vorläufig gelöscht wurden.

properties.rootSquash

RootSquashType

Die Eigenschaft gilt nur für die NFS-Freigabe. Der Standardwert ist NoRootSquash.

properties.shareQuota

integer

Die maximale Größe der Freigabe in Gigabyte. Muss größer als 0 und kleiner gleich 5 TB (5120) sein. Für große Dateifreigaben beträgt die maximale Größe 102400.

properties.shareUsageBytes

integer

Die ungefähre Größe der in der Freigabe gespeicherten Daten. Beachten Sie, dass dieser Wert möglicherweise nicht alle kürzlich erstellten oder kürzlich geänderten Dateien enthält.

properties.signedIdentifiers

SignedIdentifier[]

Liste der gespeicherten Zugriffsrichtlinien, die in der Freigabe angegeben sind.

properties.snapshotTime

string

Die Erstellungszeit der Freigabe Momentaufnahme in der Antwort von Listenfreigaben mit dem Erweiterungsparam "Momentaufnahmen" zurückgegeben.

properties.version

string

Die Version der Freigabe.

type

string

Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

FileShareItems

Antwortschema. Enthält eine Liste der zurückgegebenen Freigaben und eine URL zur nächsten Seite von Freigaben, wenn paging angefordert oder erforderlich ist.

Name Typ Beschreibung
nextLink

string

Anforderungs-URL, die zum Abfragen der nächsten Seite von Freigaben verwendet werden kann. Wird zurückgegeben, wenn die Gesamtanzahl der angeforderten Freigaben die maximale Seitengröße überschreitet.

value

FileShareItem[]

Liste der zurückgegebenen Dateifreigaben.

LeaseDuration

Gibt an, ob die Lease für eine Freigabe von unendlicher oder fester Dauer ist, nur wenn die Freigabe geleast wird.

Name Typ Beschreibung
Fixed

string

Infinite

string

LeaseState

Leasestatus der Aktie.

Name Typ Beschreibung
Available

string

Breaking

string

Broken

string

Expired

string

Leased

string

LeaseStatus

Die Lease-status der Aktie.

Name Typ Beschreibung
Locked

string

Unlocked

string

RootSquashType

Die Eigenschaft gilt nur für die NFS-Freigabe. Der Standardwert ist NoRootSquash.

Name Typ Beschreibung
AllSquash

string

NoRootSquash

string

RootSquash

string

ShareAccessTier

Zugriffsebene für eine bestimmte Freigabe. GpV2-Konto kann zwischen TransactionOptimized (Standard), Hot und Cool wählen. Das FileStorage-Konto kann Premium auswählen.

Name Typ Beschreibung
Cool

string

Hot

string

Premium

string

TransactionOptimized

string

SignedIdentifier

Name Typ Beschreibung
accessPolicy

AccessPolicy

Zugriffsrichtlinie

id

string

Ein eindeutiger Bezeichner der gespeicherten Zugriffsrichtlinie.