File Shares - List

Listes tous les partages.

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}

Paramètres URI

Nom Dans Obligatoire Type Description
accountName
path True

string

Nom du compte de stockage au sein du groupe de ressources spécifié. Ce nom doit comprendre entre 3 et 24 caractères, uniquement des lettres en minuscules et des nombres.

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

resourceGroupName
path True

string

Nom du groupe de ressources dans l’abonnement de l’utilisateur. Le nom ne respecte pas la casse.

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

subscriptionId
path True

string

ID de l’abonnement cible.

api-version
query True

string

Version de l’API à utiliser pour cette opération.

$expand
query

string

Facultatif, utilisé pour développer les propriétés dans les propriétés du partage. Les valeurs valides sont : supprimé, instantanés. Doit être passé sous forme de chaîne avec le délimiteur « , »

$filter
query

string

facultatif. Lorsqu’ils sont spécifiés, seuls les noms de partage commençant par le filtre sont répertoriés.

$maxpagesize
query

string

facultatif. Nombre maximal spécifié de partages pouvant être inclus dans la liste.

Réponses

Nom Type Description
200 OK

FileShareItems

OK -- L’opération List Shares s’est terminée avec succès.

Other Status Codes

CloudError

Réponse d’erreur décrivant la raison de l’échec de l’opération.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

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

Scopes

Nom Description
user_impersonation Emprunter l’identité de votre compte d’utilisateur

Exemples

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

Définitions

Nom Description
AccessPolicy
CloudError

Réponse d’erreur du service Stockage.

CloudErrorBody

Réponse d’erreur du service Stockage.

EnabledProtocols

Protocole d’authentification utilisé pour le partage de fichiers. Ne peut être spécifié que lors de la création d’un partage.

FileShareItem

Les propriétés du partage de fichiers sont répertoriées.

FileShareItems

Schéma de réponse. Contient la liste des partages retournés et, si la pagination est demandée ou requise, une URL vers la page suivante des partages.

LeaseDuration

Spécifie si le bail sur un partage est d’une durée infinie ou fixe, uniquement lorsque le partage est loué.

LeaseState

État du bail du partage.

LeaseStatus

Le bail status de la part.

RootSquashType

La propriété est pour le partage NFS uniquement. La valeur par défaut est NoRootSquash.

ShareAccessTier

Niveau d’accès pour un partage spécifique. Le compte GpV2 peut choisir entre TransactionOptimized (valeur par défaut), Chaud et Froid. FichierCompte de stockage peut choisir Premium.

SignedIdentifier

AccessPolicy

Nom Type Description
expiryTime

string

Heure d’expiration de la stratégie d’accès

permission

string

Liste des autorisations abrégées.

startTime

string

Heure de début de la stratégie d’accès

CloudError

Réponse d’erreur du service Stockage.

Nom Type Description
error

CloudErrorBody

Réponse d’erreur du service Stockage.

CloudErrorBody

Réponse d’erreur du service Stockage.

Nom Type Description
code

string

Identificateur de l'erreur. Les codes sont invariants et sont destinés à être consommés par programmation.

details

CloudErrorBody[]

Liste de détails supplémentaires sur l’erreur.

message

string

Message décrivant l’erreur, destiné à être adapté à l’affichage dans une interface utilisateur.

target

string

Cible de l’erreur particulière. Par exemple, le nom de la propriété en erreur.

EnabledProtocols

Protocole d’authentification utilisé pour le partage de fichiers. Ne peut être spécifié que lors de la création d’un partage.

Nom Type Description
NFS

string

SMB

string

FileShareItem

Les propriétés du partage de fichiers sont répertoriées.

Nom Type Description
etag

string

Etag de ressources.

id

string

ID de ressource complet pour la ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

nom de la ressource.

properties.accessTier

ShareAccessTier

Niveau d’accès pour un partage spécifique. Le compte GpV2 peut choisir entre TransactionOptimized (valeur par défaut), Chaud et Froid. FichierCompte de stockage peut choisir Premium.

properties.accessTierChangeTime

string

Indique l’heure de la dernière modification pour le niveau d’accès de partage.

properties.accessTierStatus

string

Indique s’il existe une transition en attente pour le niveau d’accès.

properties.deleted

boolean

Indique si le partage a été supprimé.

properties.deletedTime

string

Heure de suppression si le partage a été supprimé.

properties.enabledProtocols

EnabledProtocols

Protocole d’authentification utilisé pour le partage de fichiers. Ne peut être spécifié que lors de la création d’un partage.

properties.lastModifiedTime

string

Renvoie la date et l'heure de la dernière modification du partage.

properties.leaseDuration

LeaseDuration

Spécifie si le bail sur un partage est d’une durée infinie ou fixe, uniquement lorsque le partage est loué.

properties.leaseState

LeaseState

État du bail du partage.

properties.leaseStatus

LeaseStatus

Le bail status de la part.

properties.metadata

object

Paire nom-valeur à associer au partage en tant que métadonnées.

properties.remainingRetentionDays

integer

Jours de rétention restants pour le partage supprimé de manière réversible.

properties.rootSquash

RootSquashType

La propriété est pour le partage NFS uniquement. La valeur par défaut est NoRootSquash.

properties.shareQuota

integer

Taille maximale du partage, en gigaoctets. Doit être supérieure à 0, et inférieure ou égale à 5 To (5120) Pour les partages de fichiers volumineux, la taille maximale est 102400.

properties.shareUsageBytes

integer

Taille approximative des données stockées sur le partage. Notez que cette valeur peut ne pas inclure tous les fichiers récemment créés ou récemment redimensionnés.

properties.signedIdentifiers

SignedIdentifier[]

Liste des stratégies d’accès stockées spécifiées sur le partage.

properties.snapshotTime

string

Heure de création du partage instantané retournée dans la réponse des partages de liste avec développer param « instantanés ».

properties.version

string

Version du partage.

type

string

Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

FileShareItems

Schéma de réponse. Contient la liste des partages retournés et, si la pagination est demandée ou requise, une URL vers la page suivante des partages.

Nom Type Description
nextLink

string

URL de requête qui peut être utilisée pour interroger la page suivante des partages. Retourné lorsque le nombre total de partages demandés dépasse la taille maximale de la page.

value

FileShareItem[]

Liste des partages de fichiers retournés.

LeaseDuration

Spécifie si le bail sur un partage est d’une durée infinie ou fixe, uniquement lorsque le partage est loué.

Nom Type Description
Fixed

string

Infinite

string

LeaseState

État du bail du partage.

Nom Type Description
Available

string

Breaking

string

Broken

string

Expired

string

Leased

string

LeaseStatus

Le bail status de la part.

Nom Type Description
Locked

string

Unlocked

string

RootSquashType

La propriété est pour le partage NFS uniquement. La valeur par défaut est NoRootSquash.

Nom Type Description
AllSquash

string

NoRootSquash

string

RootSquash

string

ShareAccessTier

Niveau d’accès pour un partage spécifique. Le compte GpV2 peut choisir entre TransactionOptimized (valeur par défaut), Chaud et Froid. FichierCompte de stockage peut choisir Premium.

Nom Type Description
Cool

string

Hot

string

Premium

string

TransactionOptimized

string

SignedIdentifier

Nom Type Description
accessPolicy

AccessPolicy

Stratégie d’accès

id

string

Identificateur unique de la stratégie d’accès stockée.