Paylaşımları Listele

Makale
07/19/2023

İşlem, List Shares belirtilen hesap altındaki paylaşımların ve paylaşım anlık görüntülerinin listesini döndürür. Bu API tam olarak desteklenir, ancak eski bir yönetim API'dir. Bunun yerine, depolama kaynak sağlayıcısı (Microsoft.Storage) tarafından sağlanan Dosya Paylaşımları - Liste'yi kullanın. Depolama kaynak sağlayıcısını kullanarak kaynaklarla FileShare program aracılığıyla etkileşim kurma hakkında daha fazla bilgi edinmek için bkz. Dosya Paylaşımlarında İşlemler.

Protokol kullanılabilirliği

Etkin dosya paylaşımı protokolü	Kullanılabilir
SMB
NFS

İstek

İsteği aşağıdaki gibi oluşturabilirsiniz List Shares . HTTPS önerilir.

Yöntem	İstek URI'si	HTTP sürümü
`GET`	`https://myaccount.file.core.windows.net/?comp=list`	HTTP/1.1

İstek URI'sinde gösterilen yol bileşenlerini aşağıdaki gibi kendinizle değiştirin:

Yol bileşeni	Description
`myaccount`	Depolama hesabınızın adı.

Yol adlandırma kısıtlamalarıyla ilgili ayrıntılar için bkz. Paylaşımları, dizinleri, dosyaları ve meta verileri adlandırma ve buna başvurma.

URI parametreleri

İstek URI'sinde aşağıdaki ek parametreleri belirtebilirsiniz.

Parametre	Açıklama
`prefix`	İsteğe bağlı. Sonuçları yalnızca belirtilen ön ek ile başlayan adlara sahip paylaşımları döndürecek şekilde filtreler.
`marker`	İsteğe bağlı. Listenin bir sonraki liste işlemiyle döndürülecek bölümünü tanımlayan bir dize değeri. Döndürülen liste tamamlanmadıysa, işlem yanıt gövdesinde bir işaretçi değeri döndürür. Bundan sonra sonraki bir çağrıda işaretleyici değerini kullanarak bir sonraki liste öğesi kümesini isteyebilirsiniz. İşaretçi değeri istemci için opaktır.
`maxresults`	İsteğe bağlı. Döndürülecek en fazla paylaşım sayısını belirtir. İstek belirtmezse `maxresults`veya 5.000'den büyük bir değer belirtirse, sunucu en fazla 5.000 öğe döndürür. Parametre sıfırdan küçük veya sıfıra eşit bir değere ayarlanırsa, sunucu 400 (Hatalı İstek) durum kodu döndürür.
`include=metadata,snapshots,deleted`	İsteğe bağlı. Yanıta eklenecek bir veya daha fazla veri kümesini belirtir: - `snapshots`: Sürüm 2017-04-17 ve üzeri. Paylaşım anlık görüntülerinin yanıta eklenmesi gerektiğini belirtir. Paylaşım anlık görüntüleri yanıtta en eskisinden en yenisine kadar listelenir. - `metadata`: Yanıtta paylaşım meta verilerinin döndürülmesi gerektiğini belirtir. - `deleted`: Silinen dosya paylaşımlarının yanıta eklenmesi gerektiğini belirtir. URI'de bu seçeneklerden birden fazlasını belirtmek için, her seçeneği URL ile kodlanmış virgülle ("%82") ayırmanız gerekir. Tüm meta veri adları C# tanımlayıcıları için adlandırma kurallarına uymalıdır.
`timeout`	İsteğe bağlı. `timeout` parametresi saniye cinsinden ifade edilir. Daha fazla bilgi için bkz. Azure Dosyalar işlemleri için zaman aşımlarını ayarlama.

İstek üst bilgileri

Aşağıdaki tabloda gerekli ve isteğe bağlı istek üst bilgileri açıklanmaktadır.

İstek üst bilgisi	Açıklama
`Authorization`	Gereklidir. Yetkilendirme düzenini, hesap adını ve imzayı belirtir. Daha fazla bilgi için bkz. Azure Depolama'ya istekleri yetkilendirme.
`Date` veya `x-ms-date`	Gereklidir. İstek için Eşgüdümlü Evrensel Saat (UTC) biçimini belirtir. Daha fazla bilgi için bkz. Azure Depolama'ya istekleri yetkilendirme.
`x-ms-version`	Tüm yetkili istekler için gereklidir. Bu istek için kullanılacak işlemin sürümünü belirtir. Daha fazla bilgi için bkz. Azure Depolama hizmetleri için sürüm oluşturma.
`x-ms-client-request-id`	İsteğe bağlı. Günlüğe kaydetme yapılandırıldığında günlüklere kaydedilen 1 kibibayt (KiB) karakter sınırıyla istemci tarafından oluşturulan, opak bir değer sağlar. İstemci tarafı etkinlikleriyle sunucunun aldığı istekler arasında bağıntı sağlamak için bu üst bilgiyi kullanmanızı kesinlikle öneririz. Daha fazla bilgi için bkz. İzleme Azure Dosyalar.

İstek gövdesi

Yok.

Yanıt

Yanıt bir HTTP durum kodu, bir dizi yanıt üst bilgisi ve XML biçiminde bir yanıt gövdesi içerir.

Durum kodu

Başarılı bir işlem 200 (Tamam) durum kodunu döndürür. Durum kodları hakkında bilgi için bkz. Durum ve hata kodları.

Yanıt üst bilgileri

Bu işlemin yanıtı aşağıdaki üst bilgileri içerir. Yanıt ayrıca ek, standart HTTP üst bilgileri içerir. Tüm standart üst bilgiler HTTP/1.1 protokol belirtimine uygundur.

Yanıt üst bilgisi	Description
`Content-Type`	Standart HTTP/1.1 üst bilgisi. Sonuçların döndürüldiği biçimi belirtir. Şu anda bu değer şeklindedir `application/xml`.
`x-ms-request-id`	Bu üst bilgi, yapılan isteği benzersiz olarak tanımlar ve istek sorunlarını gidermek için kullanılabilir. Daha fazla bilgi için bkz . API işlemleriyle ilgili sorunları giderme.
`x-ms-version`	İsteği çalıştırmak için kullanılan Azure Dosyalar sürümünü gösterir.
`Date` veya `x-ms-date`	Yanıtın başlatıldığı saati gösteren UTC tarih/saat değeri. Hizmet bu değeri oluşturur.
`x-ms-client-request-id`	İsteklerde ve karşılık gelen yanıtlarda sorun gidermek için bu üst bilgiyi kullanabilirsiniz. Bu üst bilginin değeri, istekte varsa üst bilginin değerine `x-ms-client-request-id` eşittir. Değer en fazla 1024 görünür ASCII karakterdir. İstekte `x-ms-client-request-id` üst bilgi yoksa, yanıtta bu üst bilgi bulunmaz.

Yanıt gövdesi

Yanıt gövdesinin biçimi aşağıdaki gibidir.

<?xml version="1.0" encoding="utf-8"?>  
<EnumerationResults AccountName="https://myaccount.file.core.windows.net">  
  <Prefix>string-value</Prefix>  
  <Marker>string-value</Marker>  
  <MaxResults>int-value</MaxResults>  
  <Shares>  
    <Share>  
      <Name>share-name</Name>  
      <Snapshot>Date-Time Value</Snapshot>
      <Version>01D2AC0C18EDFE36</Version> 
      <Deleted>true</Deleted>  
      <Properties>  
        <Last-Modified>date/time-value</Last-Modified>  
        <Etag>etag</Etag>  
        <Quota>max-share-size</Quota>
        <DeletedTime>Mon, 24 Aug 2020 04:56:10 GMT</DeletedTime>  
        <RemainingRetentionDays>360</RemainingRetentionDays>
        <AccessTier>TransactionOptimized</AccessTier>
        <AccessTierChangeTime>Mon, 24 Aug 2020 03:56:10 GMT</AccessTierChangeTime>
        <AccessTierTransitionState>pending-from-cool</AccessTierTransitionState>
        <EnabledProtocols>SMB</EnabledProtocols>
      </Properties>  
      <Metadata>  
        <metadata-name>value</metadata-name>  
      </Metadata>  
    </Share>  
  </Shares>  
  <NextMarker>marker-value</NextMarker>  
</EnumerationResults>

EnabledProtocols öğesi yalnızca sürüm 2020-02-10 ve sonraki sürümlerde yanıt gövdesinde görünür.
RootSquash öğesi yanıt gövdesinde yalnızca etkinleştirilmiş protokoller NFS içerdiğinde sürüm 2020-02-10 ve sonraki sürümlerde görünür.
Quota öğesi yalnızca sürüm 2015-02-21 ve sonraki sürümlerde yanıt gövdesinde görünür.
Version, Deleted, DeletedTimeve RemainingRetentionDays öğeleri yalnızca sürüm 2019-12-12 ve sonraki sürümlerde yanıt gövdesinde görünür.
Prefix, Markerve MaxResults öğeleri yalnızca URI'de belirttiğinizde bulunur. öğesinin NextMarker yalnızca liste sonuçları tamamlanmazsa bir değeri vardır.
Metadata öğesi yalnızca URI'de parametresini include=metadata belirtirseniz bulunur. öğesinde Metadata , her ad-değer çiftinin değeri, çiftin adına karşılık gelen bir öğe içinde listelenir.
Anlık görüntüler yanıta yalnızca istek URI'sindeinclude=snapshots parametresiyle parametresini include belirtirseniz eklenir.
AccessTier öğesi paylaşımın katmanını tutar. Paylaşımın katmanı değiştirilmediyse, bu özellik genel amaçlı sürüm 2 (GPv2) depolama hesaplarında varsayılan katman TransactionOptimized olacaktır. Azure Dosyalar depolama hesaplarında özelliğiPremium, desteklenen tek katman olan olur.
AccessTierChangeTime öğesi yalnızca paylaşımda erişim katmanını açıkça ayarlarsanız bulunur.
AccessTierTransitionState öğesi yalnızca paylaşım bir katmandan diğerine geçişte olduğunda bulunur. Geçişini oluşturulduğunda katmanı gösterir.
ProvisionedIngressMBps öğesi yalnızca Azure Dosyalar hesapları ve sürüm 2019-07-07 veya üzeri için Premium mevcuttur. Sağlanan girişi MiB/sn olarak gösterir.
ProvisionedEgressMBps öğesi yalnızca Azure Dosyalar hesapları ve sürüm 2019-07-07 veya üzeri için Premium mevcuttur. Sağlanan çıkışı MiB/sn olarak gösterir.
ProvisionedBandwidthMiBps öğesi yalnızca Azure Dosyalar hesapları ve sürüm 2021-02-12 veya üzeri için Premium mevcuttur. MiB/sn'de sağlanan bant genişliğini (giriş + çıkış birleştirilmiş) gösterir.

Örnek yanıt

Bu konunun devamında Yer alan Örnek istek ve yanıt bölümüne bakın.

Yetkilendirme

Bu işlemi yalnızca hesap sahibi çağırabilir.

Açıklamalar

parametresi için maxresults bir değer belirtirseniz ve döndürülecek paylaşım sayısı bu değeri aşıyorsa veya için maxresultsvarsayılan değeri aşarsa, yanıt gövdesi bir NextMarker öğe içerir. Bu öğe sonraki bir istekte döndürülecek bir sonraki paylaşımı gösterir. Sonraki öğe kümesini döndürmek için değerini sonraki istek için URI'de işaretçi parametresi olarak belirtin NextMarker .

değerinin NextMarker opak olarak kabul edilmesi gerektiğini unutmayın.

Paylaşımlar yanıt gövdesinde alfabetik sırada listelenir.

İşlem List Shares 30 saniye sonra zaman aşımına uğrar.

Örnek istek ve yanıt

Aşağıdaki örnek URI, bir hesap için paylaşım listesini istemektedir. İlk işlem için döndürülecek en yüksek sonuçları üç olarak ayarlar.

GET https://myaccount.file.core.windows.net/?comp=list&maxresults=3&include=snapshots HTTP/1.1

İstek şu üst bilgilerle gönderilir:

x-ms-version: 2020-02-10  
x-ms-date: <date>  
Authorization: SharedKey myaccount:CY1OP3O3jGFpYFbTCBimLn0Xov0vt0khH/D5Gy0fXvg=

Durum kodu ve yanıt üst bilgileri aşağıdaki gibi döndürülür:

HTTP/1.1 200 OK  
Transfer-Encoding: chunked  
Content-Type: application/xml  
Date: <date>  
x-ms-version: 2020-02-10  
Server: Windows-Azure-File/1.0 Microsoft-HTTPAPI/2.0

Bu isteğin yanıt XML'i aşağıdaki gibidir. öğesinin NextMarker paylaşım kümesini izlediğini ve döndürülecek sonraki paylaşımın adını içerdiğini unutmayın.

<?xml version="1.0" encoding="utf-8"?>  
<EnumerationResults ServiceEndpoint=" https://myaccount.file.core.windows.net">  
  <MaxResults>3</MaxResults>  
  <Shares>  
    <Share>  
      <Name>audio</Name>  
      <Properties>  
        <Last-Modified><date></Last-Modified>  
        <Etag>0x8CACB9BD7C6B1B2</Etag>  
        <Quota>55</Quota>
        <AccessTier>Premium</AccessTier>
        <EnabledProtocols>SMB</EnabledProtocols>
      </Properties>  
    </Share>  
    <Share>  
      <Name>images</Name>  
      <Properties>  
        <Last-Modified><date></Last-Modified>  
        <Etag>0x8CACB9BD7C1EEEC</Etag>
        <AccessTier>Premium</AccessTier>
        <EnabledProtocols>SMB</EnabledProtocols>
      </Properties>  
    </Share>  
    <Share>
      <Name>textfiles</Name>
      <Snapshot>2017-05-12T20:52:22.0000000Z</Snapshot>
      <Properties>
        <Last-Modified><date></Last-Modified>
        <Etag>0x8D3F2E1A9D14700</Etag>
        <Quota>30</Quota>
        <AccessTier>Premium</AccessTier>
        <EnabledProtocols>NFS</EnabledProtocols>
        <RootSquash>RootSquash</RootSquash>
      </Properties>
    </Share>
    <Share>  
      <Name>textfiles</Name>  
      <Properties>  
        <Last-Modified><date></Last-Modified>  
        <Etag>0x8CACB9BD7BACAC3</Etag>  
        <Quota>30</Quota>
        <AccessTier>Premium</AccessTier>
        <EnabledProtocols>NFS</EnabledProtocols>
        <RootSquash>AllSquash</RootSquash>  
      </Properties>  
    </Share>
  </Shares>  
  <NextMarker>video</NextMarker>  
</EnumerationResults>

Sonraki liste işlemi, aşağıdaki gibi istek URI'sinde işaretçiyi belirtir. İşaretçi tarafından belirtilen paylaşımdan başlayarak sonraki sonuç kümesi döndürülür.

https://myaccount.file.core.windows.net/?comp=list&maxresults=3&marker=video

Ayrıca bkz.

REST API'Azure Dosyalar

Share via