ShareClient Sınıf
Belirli bir paylaşımla etkileşime geçmek için bir istemci, ancak bu paylaşım henüz mevcut olmayabilir.
Bu paylaşımdaki belirli bir dizin veya dosyayla ilgili işlemler için, bu varlıkların istemcileri ve get_file_client işlevleri kullanılarak get_directory_client da alınabilir.
Daha fazla isteğe bağlı yapılandırma için lütfen buraya tıklayın.
- Devralma
-
azure.storage.fileshare._shared.base_client.StorageAccountHostsMixinShareClient
Oluşturucu
ShareClient(account_url: str, share_name: str, snapshot: str | Dict[str, Any] | None = None, credential: str | Dict[str, str] | AzureNamedKeyCredential | AzureSasCredential | TokenCredential | None = None, *, token_intent: Literal['backup'] | None = None, **kwargs: Any)
Parametreler
- account_url
- str
Depolama hesabının URI'sini. Paylaşıma tam URI verilen bir istemci oluşturmak için classmethod kullanın from_share_url .
- snapshot
- str
Üzerinde çalışılan isteğe bağlı bir paylaşım anlık görüntüsü. Bu, anlık görüntü kimliği dizesi veya tarafından create_snapshotdöndürülen yanıt olabilir.
- credential
Kimlik doğrulaması için kullanılan kimlik bilgileri. Hesap URL'sinde zaten bir SAS belirteci varsa bu isteğe bağlıdır. Değer bir SAS belirteci dizesi, azure.core.credentials öğesinden AzureSasCredential veya AzureNamedKeyCredential örneği, hesap paylaşılan erişim anahtarı veya azure.identity'den tokenCredentials sınıfının bir örneği olabilir. Kaynak URI'sinde zaten bir SAS belirteci varsa, bu durum açık bir kimlik bilgisi lehine yoksayılır
- Çakışan SAS belirteçlerinin bir ValueError oluşturacağı AzureSasCredential durumu dışında. AzureNamedKeyCredential örneğini kullanıyorsanız depolama hesabı adı "name" ve depolama hesabı anahtarı "anahtar" olmalıdır.
- token_intent
- Literal['backup']
Kimlik doğrulaması için TokenCredential kullanılırken gereklidir ve diğer kimlik doğrulama biçimleri için yoksayılır. TokenCredential kimlik doğrulaması kullanılırken tüm isteklerin amacını belirtir. Olası değerler şunlardır:
backup - İsteklerin yedekleme/yönetici türü işlemlerine yönelik olduğunu belirtir; yani tüm dosya/dizin ACL'lerinin atlandığı ve tam izinlerin verildiği anlamına gelir. Kullanıcının gerekli RBAC izni de olmalıdır.
- allow_trailing_dot
- bool
True ise, sondaki nokta hedef URI'den kırpılmaz.
- allow_source_trailing_dot
- bool
True ise, sondaki nokta kaynak URI'den kırpılmaz.
- api_version
- str
İstekler için kullanılacak Depolama API'sinin sürümü. Varsayılan değer, geçerli SDK ile uyumlu olan en son hizmet sürümüdür. Eski bir sürüme ayarlamak özellik uyumluluğunu azaltabilir.
Sürüm 12.1.0'da yeni.
- secondary_hostname
- str
İkincil uç noktanın ana bilgisayar adı.
- max_range_size
- int
Dosya karşıya yükleme için kullanılan en büyük aralık boyutu. Varsayılan değer 4*1024*1024
'tir.
Yöntemler
acquire_lease |
Yeni kiralama isteğinde bulunur. Paylaşımın etkin kiralaması yoksa, Paylaşım Hizmeti paylaşımda bir kira oluşturur ve yeni bir kira döndürür. Sürüm 12.5.0'da yeni. |
close |
Bu yöntem, istemci tarafından açılan yuvaları kapatmaktır. Bağlam yöneticisi ile kullanılırken kullanılması gerekmez. |
create_directory |
Paylaşımda bir dizin oluşturur ve dizinle etkileşime geçmek için bir istemci döndürür. |
create_permission_for_share |
Paylaşım düzeyinde bir izin (güvenlik tanımlayıcısı) oluşturun. Bu 'izin' paylaşımdaki dosyalar/dizinler için kullanılabilir. Bir 'izin' zaten varsa anahtarını döndürür, aksi takdirde paylaşım düzeyinde yeni bir izin oluşturur ve anahtarını döndürür. |
create_share |
Hesabın altında yeni bir Paylaşım oluşturur. Aynı ada sahip bir paylaşım zaten varsa işlem başarısız olur. |
create_snapshot |
Paylaşımın anlık görüntüsünü oluşturur. Anlık görüntü, bir paylaşımın belirli bir noktada alınmış salt okunur bir sürümüdür. Okunabilir, kopyalanabilir veya silinebilir, ancak değiştirilemez. Anlık görüntüler, bir paylaşımı belirli bir anda göründüğü şekilde yedeklemek için bir yol sağlar. Bir paylaşımın anlık görüntüsü, anlık görüntünün alındığı temel paylaşımla aynı ada sahiptir ve anlık görüntünün alındığı saati belirtmek için bir DateTime değeri eklenir. |
delete_directory |
Dizini silinmek üzere işaretler. Dizin daha sonra çöp toplama sırasında silinir. |
delete_share |
Belirtilen paylaşımı silinmek üzere işaretler. Paylaşım daha sonra çöp toplama sırasında silinir. |
from_connection_string |
Bağlantı Dizesinden ShareClient oluşturun. |
from_share_url | |
get_directory_client |
Belirtilen dizinle etkileşime geçmek için bir istemci alın. Dizinin zaten mevcut olması gerekmez. |
get_file_client |
Belirtilen dosyayla etkileşime geçmek için bir istemci alın. Dosyanın zaten var olması gerekmiyor. |
get_permission_for_share |
Belirli bir anahtar için bir izin (güvenlik tanımlayıcısı) alın. Bu 'izin' paylaşımdaki dosyalar/dizinler için kullanılabilir. |
get_share_access_policy |
Paylaşım izinlerini alır. İzinler, bir paylaşımdaki dosyalara genel olarak erişilip erişilemeyeceğini gösterir. |
get_share_properties |
Belirtilen paylaşım için tüm kullanıcı tanımlı meta verileri ve sistem özelliklerini döndürür. Döndürülen veriler paylaşımların dosya veya dizin listesini içermez. |
get_share_stats |
Paylaşımda depolanan verilerin bayt cinsinden yaklaşık boyutunu alır. Bu değerin son oluşturulan veya son boyutlandırılan dosyaların tümünü içeremediğini unutmayın. |
list_directories_and_files |
Paylaşımın altındaki dizinleri ve dosyaları listeler. |
set_share_access_policy |
Paylaşılan Erişim İmzaları ile kullanılabilecek paylaşım veya depolanmış erişim ilkelerinin izinlerini ayarlar. İzinler, bir paylaşımdaki dosyalara genel olarak erişilip erişilemeyeceğini gösterir. |
set_share_metadata |
Paylaşımın meta verilerini ayarlar. Bu işleme yapılan her çağrı, paylaşıma eklenen tüm mevcut meta verilerin yerini alır. Paylaşımdaki tüm meta verileri kaldırmak için, meta veri diktesi olmadan bu işlemi çağırın. |
set_share_properties |
Paylaşım özelliklerini ayarlar. Sürüm 12.4.0'da yeni. |
set_share_quota |
Paylaşım kotasını ayarlar. |
acquire_lease
Yeni kiralama isteğinde bulunur.
Paylaşımın etkin kiralaması yoksa, Paylaşım Hizmeti paylaşımda bir kira oluşturur ve yeni bir kira döndürür.
Sürüm 12.5.0'da yeni.
acquire_lease(**kwargs: Any) -> ShareLeaseClient
Parametreler
- lease_duration
- int
Süresi hiç dolmamış bir kiralama için kiranın süresini saniye cinsinden veya negatif bir (-1) olarak belirtir. Sonsuz olmayan kiralama 15 ile 60 saniye arasında olabilir. Kiralama süresi yenileme veya değiştirme kullanılarak değiştirilemez. Varsayılan değer -1'dir (sonsuz kiralama).
- lease_id
- str
GUID dize biçiminde önerilen kira kimliği. Önerilen kira kimliği doğru biçimde değilse, Paylaşım Hizmeti 400 (Geçersiz istek) döndürür.
- timeout
- int
İşlemin sunucu tarafı zaman aşımını saniye olarak ayarlar. Diğer ayrıntılar için bkz: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Bu değer istemcide izlenmez veya doğrulanmaz. İstemci tarafı ağ zaman aşımlarını yapılandırmak için buraya bakın.
Döndürülenler
ShareLeaseClient nesnesi.
Dönüş türü
Örnekler
Bir paylaşım için kira alma.
share.create_directory("mydir")
lease = share.acquire_lease()
share.get_share_properties(lease=lease)
share.delete_share(lease=lease)
close
Bu yöntem, istemci tarafından açılan yuvaları kapatmaktır. Bağlam yöneticisi ile kullanılırken kullanılması gerekmez.
close()
create_directory
Paylaşımda bir dizin oluşturur ve dizinle etkileşime geçmek için bir istemci döndürür.
create_directory(directory_name: str, **kwargs: Any) -> ShareDirectoryClient
Parametreler
- metadata
Dizinle meta veri olarak ilişkili ad-değer çiftleri.
- timeout
- int
İşlemin sunucu tarafı zaman aşımını saniye olarak ayarlar. Diğer ayrıntılar için bkz: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Bu değer istemcide izlenmez veya doğrulanmaz. İstemci tarafı ağ zaman aşımlarını yapılandırmak için buraya bakın.
Döndürülenler
ShareDirectoryClient
Dönüş türü
create_permission_for_share
Paylaşım düzeyinde bir izin (güvenlik tanımlayıcısı) oluşturun.
Bu 'izin' paylaşımdaki dosyalar/dizinler için kullanılabilir. Bir 'izin' zaten varsa anahtarını döndürür, aksi takdirde paylaşım düzeyinde yeni bir izin oluşturur ve anahtarını döndürür.
create_permission_for_share(file_permission: str, **kwargs: Any) -> str
Parametreler
- timeout
- int
İşlemin sunucu tarafı zaman aşımını saniye olarak ayarlar. Diğer ayrıntılar için bkz: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Bu değer istemcide izlenmez veya doğrulanmaz. İstemci tarafı ağ zaman aşımlarını yapılandırmak için buraya bakın.
Döndürülenler
Dosya izin anahtarı
Dönüş türü
create_share
Hesabın altında yeni bir Paylaşım oluşturur. Aynı ada sahip bir paylaşım zaten varsa işlem başarısız olur.
create_share(**kwargs: Any) -> Dict[str, Any]
Parametreler
- quota
- int
Ayrılan kota.
- access_tier
Paylaşımın erişim katmanını belirtir. Olası değerler: 'TransactionOptimized', 'Hot', 'Cool'
- timeout
- int
İşlemin sunucu tarafı zaman aşımını saniye olarak ayarlar. Diğer ayrıntılar için bkz: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Bu değer istemcide izlenmez veya doğrulanmaz. İstemci tarafı ağ zaman aşımlarını yapılandırmak için buraya bakın.
- protocols
- str veya ShareProtocols
Paylaşımda etkinleştirecek protokoller. Paylaşımda yalnızca bir protokol etkinleştirilebilir.
- root_squash
- str veya ShareRootSquash
Paylaşımda ayarlamak için kök kabak. Yalnızca NFS paylaşımları için geçerlidir. Olası değerler şunlardır: 'NoRootSquash', 'RootSquash', 'AllSquash'.
Döndürülenler
Paylaşımla güncelleştirilmiş özellik diktesi (Etag ve son değiştirme).
Dönüş türü
Örnekler
Dosya paylaşımı oluşturur.
# Create share with Access Tier set to Hot
share.create_share(access_tier=ShareAccessTier("Hot"))
create_snapshot
Paylaşımın anlık görüntüsünü oluşturur.
Anlık görüntü, bir paylaşımın belirli bir noktada alınmış salt okunur bir sürümüdür. Okunabilir, kopyalanabilir veya silinebilir, ancak değiştirilemez. Anlık görüntüler, bir paylaşımı belirli bir anda göründüğü şekilde yedeklemek için bir yol sağlar.
Bir paylaşımın anlık görüntüsü, anlık görüntünün alındığı temel paylaşımla aynı ada sahiptir ve anlık görüntünün alındığı saati belirtmek için bir DateTime değeri eklenir.
create_snapshot(**kwargs: Any | None) -> Dict[str, Any]
Parametreler
- timeout
- int
İşlemin sunucu tarafı zaman aşımını saniye olarak ayarlar. Diğer ayrıntılar için bkz: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Bu değer istemcide izlenmez veya doğrulanmaz. İstemci tarafı ağ zaman aşımlarını yapılandırmak için buraya bakın.
Döndürülenler
Paylaşımla güncelleştirilmiş özellik diktesi (Anlık Görüntü Kimliği, Etag ve son değiştirme).
Dönüş türü
Örnekler
Dosya paylaşımının anlık görüntüsünü oluşturur.
share.create_snapshot()
delete_directory
Dizini silinmek üzere işaretler. Dizin daha sonra çöp toplama sırasında silinir.
delete_directory(directory_name: str, **kwargs: Any) -> None
Parametreler
- timeout
- int
İşlemin sunucu tarafı zaman aşımını saniye olarak ayarlar. Diğer ayrıntılar için bkz: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Bu değer istemcide izlenmez veya doğrulanmaz. İstemci tarafı ağ zaman aşımlarını yapılandırmak için buraya bakın.
Dönüş türü
delete_share
Belirtilen paylaşımı silinmek üzere işaretler. Paylaşım daha sonra çöp toplama sırasında silinir.
delete_share(delete_snapshots: bool | None = False, **kwargs) -> None
Parametreler
- lease
Paylaşımın etkin bir kirası varsa gereklidir. Değer bir ShareLeaseClient nesnesi veya dize olarak kira kimliği olabilir.
Sürüm 12.5.0'da yeni.
Bu anahtar sözcük bağımsız değişkeni '2020-08-04' API sürümünde kullanıma sunulmuştur.
- timeout
- int
İşlemin sunucu tarafı zaman aşımını saniye olarak ayarlar. Diğer ayrıntılar için bkz: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Bu değer istemcide izlenmez veya doğrulanmaz. İstemci tarafı ağ zaman aşımlarını yapılandırmak için buraya bakın.
Örnekler
Paylaşımı ve tüm anlık görüntüleri siler.
share.delete_share(delete_snapshots=True)
from_connection_string
Bağlantı Dizesinden ShareClient oluşturun.
from_connection_string(conn_str: str, share_name: str, snapshot: str | Dict[str, Any] | None = None, credential: str | Dict[str, str] | AzureNamedKeyCredential | AzureSasCredential | TokenCredential | None = None, **kwargs: Any) -> Self
Parametreler
- snapshot
- str
Üzerinde çalışılan isteğe bağlı paylaşım anlık görüntüsü. Bu, anlık görüntü kimliği dizesi veya tarafından create_snapshotdöndürülen yanıt olabilir.
- credential
Kimlik doğrulaması için kullanılan kimlik bilgileri. Hesap URL'sinde zaten bir SAS belirteci varsa bu isteğe bağlıdır. Değer bir SAS belirteci dizesi, azure.core.credentials öğesinden AzureSasCredential veya AzureNamedKeyCredential örneği, hesap paylaşılan erişim anahtarı veya azure.identity'den tokenCredentials sınıfının bir örneği olabilir. Kaynak URI'sinde zaten bir SAS belirteci varsa, bu durum açık bir kimlik bilgisi lehine yoksayılır
- Çakışan SAS belirteçlerinin bir ValueError oluşturacağı AzureSasCredential durumu dışında. AzureNamedKeyCredential örneğini kullanıyorsanız depolama hesabı adı "name" ve depolama hesabı anahtarı "anahtar" olmalıdır.
Döndürülenler
Paylaşım istemcisi.
Dönüş türü
Örnekler
Bağlantı dizesinden paylaşım istemcisini alır.
from azure.storage.fileshare import ShareClient
share = ShareClient.from_connection_string(self.connection_string, "sharesamples2")
from_share_url
from_share_url(share_url: str, snapshot: str | Dict[str, Any] | None = None, credential: str | Dict[str, str] | AzureNamedKeyCredential | AzureSasCredential | TokenCredential | None = None, **kwargs: Any) -> Self
Parametreler
- snapshot
- str
Üzerinde çalışılan isteğe bağlı bir paylaşım anlık görüntüsü. Bu, anlık görüntü kimliği dizesi veya tarafından create_snapshotdöndürülen yanıt olabilir.
- credential
Kimlik doğrulaması için kullanılan kimlik bilgileri. Hesap URL'sinde zaten bir SAS belirteci varsa bu isteğe bağlıdır. Değer bir SAS belirteci dizesi, azure.core.credentials öğesinden AzureSasCredential veya AzureNamedKeyCredential örneği, hesap paylaşılan erişim anahtarı veya azure.identity'den tokenCredentials sınıfının bir örneği olabilir. Kaynak URI'sinde zaten bir SAS belirteci varsa, bu durum açık bir kimlik bilgisi lehine yoksayılır
- Çakışan SAS belirteçlerinin bir ValueError oluşturacağı AzureSasCredential durumu dışında. AzureNamedKeyCredential örneğini kullanıyorsanız depolama hesabı adı "name" ve depolama hesabı anahtarı "anahtar" olmalıdır.
Döndürülenler
Paylaşım istemcisi.
Dönüş türü
get_directory_client
Belirtilen dizinle etkileşime geçmek için bir istemci alın. Dizinin zaten mevcut olması gerekmez.
get_directory_client(directory_path: str | None = None) -> ShareDirectoryClient
Parametreler
Döndürülenler
Dizin İstemcisi.
Dönüş türü
get_file_client
Belirtilen dosyayla etkileşime geçmek için bir istemci alın. Dosyanın zaten var olması gerekmiyor.
get_file_client(file_path: str) -> ShareFileClient
Parametreler
Döndürülenler
Dosya İstemcisi.
Dönüş türü
get_permission_for_share
Belirli bir anahtar için bir izin (güvenlik tanımlayıcısı) alın.
Bu 'izin' paylaşımdaki dosyalar/dizinler için kullanılabilir.
get_permission_for_share(permission_key: str, **kwargs: Any) -> str
Parametreler
- timeout
- int
İşlemin sunucu tarafı zaman aşımını saniye olarak ayarlar. Diğer ayrıntılar için bkz: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Bu değer istemcide izlenmez veya doğrulanmaz. İstemci tarafı ağ zaman aşımlarını yapılandırmak için buraya bakın.
Döndürülenler
Dosya izni (taşınabilir SDDL)
Dönüş türü
get_share_access_policy
Paylaşım izinlerini alır. İzinler, bir paylaşımdaki dosyalara genel olarak erişilip erişilemeyeceğini gösterir.
get_share_access_policy(**kwargs: Any) -> Dict[str, Any]
Parametreler
- timeout
- int
İşlemin sunucu tarafı zaman aşımını saniye olarak ayarlar. Diğer ayrıntılar için bkz: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Bu değer istemcide izlenmez veya doğrulanmaz. İstemci tarafı ağ zaman aşımlarını yapılandırmak için buraya bakın.
- lease
Paylaşımın etkin bir kirası varsa gereklidir. Değer bir ShareLeaseClient nesnesi veya dize olarak kira kimliği olabilir.
Sürüm 12.5.0'da yeni.
Bu anahtar sözcük bağımsız değişkeni '2020-08-04' API sürümünde kullanıma sunulmuştur.
Döndürülenler
Bir dikte ilke bilgilerine erişin.
Dönüş türü
get_share_properties
Belirtilen paylaşım için tüm kullanıcı tanımlı meta verileri ve sistem özelliklerini döndürür. Döndürülen veriler paylaşımların dosya veya dizin listesini içermez.
get_share_properties(**kwargs: Any) -> ShareProperties
Parametreler
- timeout
- int
İşlemin sunucu tarafı zaman aşımını saniye olarak ayarlar. Diğer ayrıntılar için bkz: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Bu değer istemcide izlenmez veya doğrulanmaz. İstemci tarafı ağ zaman aşımlarını yapılandırmak için buraya bakın.
- lease
Paylaşımın etkin bir kirası varsa gereklidir. Değer bir ShareLeaseClient nesnesi veya dize olarak kira kimliği olabilir.
Sürüm 12.5.0'da yeni.
Bu anahtar sözcük bağımsız değişkeni '2020-08-04' API sürümünde kullanıma sunulmuştur.
Döndürülenler
Paylaşım özellikleri.
Dönüş türü
Örnekler
Paylaşım özelliklerini alır.
properties = share.get_share_properties()
get_share_stats
Paylaşımda depolanan verilerin bayt cinsinden yaklaşık boyutunu alır.
Bu değerin son oluşturulan veya son boyutlandırılan dosyaların tümünü içeremediğini unutmayın.
get_share_stats(**kwargs: Any) -> int
Parametreler
- timeout
- int
İşlemin sunucu tarafı zaman aşımını saniye olarak ayarlar. Diğer ayrıntılar için bkz: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Bu değer istemcide izlenmez veya doğrulanmaz. İstemci tarafı ağ zaman aşımlarını yapılandırmak için buraya bakın.
- lease
Paylaşımın etkin bir kirası varsa gereklidir. Değer bir ShareLeaseClient nesnesi veya dize olarak kira kimliği olabilir.
Sürüm 12.5.0'da yeni.
Bu anahtar sözcük bağımsız değişkeni '2020-08-04' API sürümünde kullanıma sunulmuştur.
Döndürülenler
Paylaşımda depolanan verilerin yaklaşık boyutu (bayt cinsinden).
Dönüş türü
list_directories_and_files
Paylaşımın altındaki dizinleri ve dosyaları listeler.
list_directories_and_files(directory_name: str | None = None, name_starts_with: str | None = None, marker: str | None = None, **kwargs: Any) -> Iterable[Dict[str, str]]
Parametreler
- name_starts_with
- str
Sonuçları yalnızca adları belirtilen ön ek ile başlayan dizinleri döndürecek şekilde filtreler.
- marker
- str
Donuk bir devamlılık belirteci. Bu değer, önceki bir oluşturucu nesnesinin next_marker alanından alınabilir. Belirtilirse, bu oluşturucu bu noktadan sonuç döndürmeye başlar.
Yanıta eklenecek bir veya daha fazla veri kümesini belirtmek için bu parametreyi ekleyin. Olası str değerleri şunlardır: "zaman damgaları", "Etag", "Öznitelikler", "PermissionKey".
Sürüm 12.6.0'da yeni.
Bu anahtar sözcük bağımsız değişkeni '2020-10-02' API sürümünde sunulmuştur.
- include_extended_info
- bool
Bu true olarak ayarlanırsa, dosya kimliği listelenen sonuçlarda döndürülür.
Sürüm 12.6.0'da yeni.
Bu anahtar sözcük bağımsız değişkeni '2020-10-02' API sürümünde sunulmuştur.
- timeout
- int
İşlemin sunucu tarafı zaman aşımını saniye olarak ayarlar. Diğer ayrıntılar için bkz: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Bu değer istemcide izlenmez veya doğrulanmaz. İstemci tarafı ağ zaman aşımlarını yapılandırmak için buraya bakın.
Döndürülenler
Dikte benzeri DirectoryProperties ve FileProperties otomatik olarak sayfalanabilir
Dönüş türü
Örnekler
Paylaşımdaki dizinleri ve dosyaları listeleyin.
# Create a directory in the share
dir_client = share.create_directory("mydir")
# Upload a file to the directory
with open(SOURCE_FILE, "rb") as source_file:
dir_client.upload_file(file_name="sample", data=source_file)
# List files in the directory
my_files = list(share.list_directories_and_files(directory_name="mydir"))
print(my_files)
set_share_access_policy
Paylaşılan Erişim İmzaları ile kullanılabilecek paylaşım veya depolanmış erişim ilkelerinin izinlerini ayarlar. İzinler, bir paylaşımdaki dosyalara genel olarak erişilip erişilemeyeceğini gösterir.
set_share_access_policy(signed_identifiers: Dict[str, AccessPolicy], **kwargs: Any) -> Dict[str, str]
Parametreler
- signed_identifiers
- dict(str, AccessPolicy)
Paylaşımla ilişkilendirilecek erişim ilkeleri sözlüğü. Sözlük en fazla 5 öğe içerebilir. Boş bir sözlük, hizmette ayarlanan erişim ilkelerini temizler.
- timeout
- int
İşlemin sunucu tarafı zaman aşımını saniye olarak ayarlar. Diğer ayrıntılar için bkz: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Bu değer istemcide izlenmez veya doğrulanmaz. İstemci tarafı ağ zaman aşımlarını yapılandırmak için buraya bakın.
- lease
Paylaşımın etkin bir kirası varsa gereklidir. Değer bir ShareLeaseClient nesnesi veya dize olarak kira kimliği olabilir.
Sürüm 12.5.0'da yeni.
Bu anahtar sözcük bağımsız değişkeni '2020-08-04' API sürümünde kullanıma sunulmuştur.
Döndürülenler
Paylaşımla güncelleştirilmiş özellik diktesi (Etag ve son değiştirme).
Dönüş türü
set_share_metadata
Paylaşımın meta verilerini ayarlar.
Bu işleme yapılan her çağrı, paylaşıma eklenen tüm mevcut meta verilerin yerini alır. Paylaşımdaki tüm meta verileri kaldırmak için, meta veri diktesi olmadan bu işlemi çağırın.
set_share_metadata(metadata: Dict[str, Any], **kwargs: Any) -> Dict[str, Any]
Parametreler
- timeout
- int
İşlemin sunucu tarafı zaman aşımını saniye olarak ayarlar. Diğer ayrıntılar için bkz: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Bu değer istemcide izlenmez veya doğrulanmaz. İstemci tarafı ağ zaman aşımlarını yapılandırmak için buraya bakın.
- lease
Paylaşımın etkin bir kirası varsa gereklidir. Değer bir ShareLeaseClient nesnesi veya dize olarak kira kimliği olabilir.
Sürüm 12.5.0'da yeni.
Bu anahtar sözcük bağımsız değişkeni '2020-08-04' API sürümünde kullanıma sunulmuştur.
Döndürülenler
Paylaşımla güncelleştirilmiş özellik diktesi (Etag ve son değiştirme).
Dönüş türü
Örnekler
Paylaşım meta verilerini ayarlar.
data = {'category': 'test'}
share.set_share_metadata(metadata=data)
set_share_properties
Paylaşım özelliklerini ayarlar.
Sürüm 12.4.0'da yeni.
set_share_properties(**kwargs: Any) -> Dict[str, Any]
Parametreler
- access_tier
- str veya <xref:azure.storage.fileshare.models.ShareAccessTier>
Paylaşımın erişim katmanını belirtir. Olası değerler: 'TransactionOptimized', 'Hot' ve 'Cool'
- quota
- int
Paylaşımın en büyük boyutunu gigabayt cinsinden belirtir. 0'dan büyük ve 5 TB'tan küçük veya buna eşit olmalıdır.
- timeout
- int
İşlemin sunucu tarafı zaman aşımını saniye olarak ayarlar. Diğer ayrıntılar için bkz: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Bu değer istemcide izlenmez veya doğrulanmaz. İstemci tarafı ağ zaman aşımlarını yapılandırmak için buraya bakın.
- root_squash
- str veya ShareRootSquash
Paylaşımda ayarlamak için kök kabak. Yalnızca NFS paylaşımları için geçerlidir. Olası değerler şunlardır: 'NoRootSquash', 'RootSquash', 'AllSquash'.
- lease
Paylaşımın etkin bir kirası varsa gereklidir. Değer bir ShareLeaseClient nesnesi veya dize olarak kira kimliği olabilir.
Döndürülenler
Paylaşımla güncelleştirilmiş özellik diktesi (Etag ve son değiştirme).
Dönüş türü
Örnekler
Paylaşım özelliklerini ayarlar.
# Set the tier for the first share to Hot
share1.set_share_properties(access_tier="Hot")
# Set the quota for the first share to 3
share1.set_share_properties(quota=3)
# Set the tier for the second share to Cool and quota to 2
share2.set_share_properties(access_tier=ShareAccessTier("Cool"), quota=2)
# Get the shares' properties
print(share1.get_share_properties().access_tier)
print(share1.get_share_properties().quota)
print(share2.get_share_properties().access_tier)
print(share2.get_share_properties().quota)
set_share_quota
Paylaşım kotasını ayarlar.
set_share_quota(quota: int, **kwargs: Any) -> Dict[str, Any]
Parametreler
- quota
- int
Paylaşımın en büyük boyutunu gigabayt cinsinden belirtir. 0'dan büyük ve 5 TB'tan küçük veya buna eşit olmalıdır.
- timeout
- int
İşlemin sunucu tarafı zaman aşımını saniye olarak ayarlar. Diğer ayrıntılar için bkz: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Bu değer istemcide izlenmez veya doğrulanmaz. İstemci tarafı ağ zaman aşımlarını yapılandırmak için buraya bakın.
- lease
Paylaşımın etkin bir kirası varsa gereklidir. Değer bir ShareLeaseClient nesnesi veya dize olarak kira kimliği olabilir.
Sürüm 12.5.0'da yeni.
Bu anahtar sözcük bağımsız değişkeni '2020-08-04' API sürümünde kullanıma sunulmuştur.
Döndürülenler
Paylaşımla güncelleştirilmiş özellik diktesi (Etag ve son değiştirme).
Dönüş türü
Örnekler
Paylaşım kotasını ayarlar.
# Set the quota for the share to 1GB
share.set_share_quota(quota=1)
Öznitelikler
api_version
İstekler için kullanılan Depolama API'sinin sürümü.
location_mode
İstemcinin şu anda kullandığı konum modu.
Varsayılan olarak bu "birincil" olur. Seçenekler arasında "birincil" ve "ikincil" bulunur.
primary_endpoint
Tam birincil uç nokta URL'si.
primary_hostname
Birincil uç noktanın ana bilgisayar adı.
secondary_endpoint
Yapılandırıldıysa tam ikincil uç nokta URL'si.
Kullanılamıyorsa bir ValueError oluşturulur. İkincil ana bilgisayar adını açıkça belirtmek için, örneklemede isteğe bağlı secondary_hostname anahtar sözcük bağımsız değişkenini kullanın.
Özel durumlar
secondary_hostname
İkincil uç noktanın ana bilgisayar adı.
Kullanılamıyorsa, bu Yok olur. İkincil ana bilgisayar adını açıkça belirtmek için, örneklemede isteğe bağlı secondary_hostname anahtar sözcük bağımsız değişkenini kullanın.
url
Kullanılırsa SAS belirteci de dahil olmak üzere bu varlığın tam uç nokta URL'si.
Bu birincil uç nokta veya geçerli location_modeöğesine bağlı olarak ikincil uç nokta olabilir. :returns: Kullanıldıysa SAS belirteci de dahil olmak üzere bu varlığa ilişkin tam uç nokta URL'si. :rtype: str
Azure SDK for Python
Geri Bildirim
https://aka.ms/ContentUserFeedback.
Çok yakında: 2024 boyunca, içerik için geri bildirim mekanizması olarak GitHub Sorunları’nı kullanımdan kaldıracak ve yeni bir geri bildirim sistemiyle değiştireceğiz. Daha fazla bilgi için bkz.Gönderin ve geri bildirimi görüntüleyin