ShareDirectoryClient Sınıf

Henüz mevcut olmasa da belirli bir dizinle etkileşime geçmek için bir istemci.

Bu paylaşımdaki belirli bir alt dizin veya dosyayla ilgili işlemler için, bu varlıkların istemcileri ve get_file_client işlevleri kullanılarak get_subdirectory_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.StorageAccountHostsMixin

ShareDirectoryClient

Oluşturucu

ShareDirectoryClient(account_url: str, share_name: str, directory_path: 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

Gerekli

Depolama hesabının URI'sini. Dizinine tam URI verilen bir istemci oluşturmak için classmethod kullanın from_directory_url .

share_name

str

Gerekli

Dizinin paylaşımının adı.

directory_path

str

Gerekli

Etkileşim kurulacak dizinin dizin yolu. Belirtilirse, bu değer dizin URL'sinde belirtilen bir dizin değerini geçersiz kılar.

snapshot

str

varsayılan değer: None

Ü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

varsayılan değer: None

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.

audience

str

Azure Active Directory kimlik doğrulaması için belirteçler istenirken kullanılacak hedef kitle. Yalnızca kimlik bilgisi TokenCredential türünde olduğunda bir etkiye sahiptir. Değer (varsayılan) veya https://.file.core.windows.net olabilir https://storage.azure.com/ .

Yöntemler

close	Bu yöntem, istemci tarafından açılan yuvaları kapatmaktır. Bağlam yöneticisi ile kullanılırken kullanılması gerekmez.
close_all_handles	Açık dosya tanıtıcılarını kapatın. Bu işlem, hizmet tüm açık tanıtıcıları kapatana kadar engeller.
close_handle	Açık bir dosya tanıtıcısını kapatın.
create_directory	İstemci tarafından başvuruda bulunan dizin altında yeni bir dizin oluşturur.
create_subdirectory	Yeni bir alt dizin oluşturur ve alt dizinle etkileşime geçmek için bir istemci döndürür.
delete_directory	Dizini silinmek üzere işaretler. Dizin daha sonra çöp toplama sırasında silinir.
delete_file	Belirtilen dosyayı silinmek üzere işaretler. Dosya daha sonra çöp toplama sırasında silinir.
delete_subdirectory	Bir alt dizini siler.
exists	Bir dizin varsa True döndürür ve aksi takdirde False döndürür.
from_connection_string	Bağlantı Dizesinden ShareDirectoryClient oluşturun.
from_directory_url	Dizin url'sinden ShareDirectoryClient oluşturun.
get_directory_properties	Belirtilen dizin için tüm kullanıcı tanımlı meta verileri ve sistem özelliklerini döndürür. Döndürülen veriler dizinin dosya listesini içermez.
get_file_client	İstemcinin belirli bir dosyayla etkileşim kurmasını sağlayın. Dosya zaten mevcut değil.
get_subdirectory_client	İstemcinin belirli bir alt dizinle etkileşim kurmasını sağlayın. Alt dizinin zaten mevcut olması gerekmez.
list_directories_and_files	Dizinin altındaki tüm dizinleri ve dosyaları listeler.
list_handles	Dizindeki veya dizinin altındaki bir dosyadaki açık tanıtıcıları listeler.
rename_directory	Kaynak dizini yeniden adlandırın. :p aramtype file_attributes:~azure.storage.fileshare.NTFSAttributes veya str :keyword file_creation_time: Dizin için oluşturma zamanı. :p aramtype file_creation_time:~datetime.datetime veya str :keyword file_last_write_time: Dosya için son yazma zamanı. :p aramtype file_last_write_time:~datetime.datetime veya str :keyword file_change_time: Dizinin süresini değiştirin. Belirtilmezse, değişiklik saati geçerli tarih/saat olarak ayarlanır. Sürüm 12.8.0'da yeni eklendi: Bu parametre '2021-06-08' API sürümünde kullanıma sunulmuştur.
set_directory_metadata	Dizinin meta verilerini ayarlar. Bu işleme yapılan her çağrı, dizinine eklenmiş olan tüm meta verilerin yerini alır. Dizindeki tüm meta verileri kaldırmak için bu işlemi boş bir meta veri diktesi ile çağırın.
set_http_headers	Dizinde HTTP üst bilgilerini ayarlar.
upload_file	Dizininde yeni bir dosya oluşturur ve dosyayla etkileşime geçmek için bir ShareFileClient döndürür.

close

Bu yöntem, istemci tarafından açılan yuvaları kapatmaktır. Bağlam yöneticisi ile kullanılırken kullanılması gerekmez.

close()

close_all_handles

Açık dosya tanıtıcılarını kapatın.

Bu işlem, hizmet tüm açık tanıtıcıları kapatana kadar engeller.

close_all_handles(recursive: bool = False, **kwargs: Any) -> Dict[str, int]

Parametreler

recursive

bool

Gerekli

İşlemin istemci tarafından belirtilen dizine, dosyalarına, alt dizinlerine ve dosyalarına uygulanıp uygulanacağını belirten Boole değeri. Varsayılan değerdir False’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

Kapatılan tanıtıcı sayısı (belirtilen tanıtıcı bulunamadıysa 0 olabilir) ve bir dikte kapatılamayan tanıtıcı sayısı.

Dönüş türü

dict[str, int]

close_handle

Açık bir dosya tanıtıcısını kapatın.

close_handle(handle: str | Handle, **kwargs: Any) -> Dict[str, int]

Parametreler

handle

str veya Handle

Gerekli

Kapatacak belirli bir tanıtıcı.

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

Kapatılan tanıtıcı sayısı (belirtilen tanıtıcı bulunamadıysa 0 olabilir) ve bir dikte kapatılamayan tanıtıcı sayısı.

Dönüş türü

dict[str, int]

create_directory

İstemci tarafından başvuruda bulunan dizin altında yeni bir dizin oluşturur.

create_directory(**kwargs: Any) -> Dict[str, Any]

Parametreler

file_attributes

NTFSAttributes

Dosyalar ve dizinler için dosya sistemi öznitelikleri. Ayarlanmadıysa, varsayılan değer "yok" olur ve öznitelikler "Arşiv" olarak ayarlanır. Burada, var türünün ne zaman str olduğuna ilişkin bir örnek verilmiştir: 'Geçici|Arşivle'. file_attributes değer büyük/küçük harfe duyarlı değildir.

file_creation_time

str veya datetime

Dizin için oluşturma zamanı. Varsayılan değer: "now".

file_last_write_time

str veya datetime

Dizin için son yazma zamanı. Varsayılan değer: "now".

file_permission

str

Belirtilirse, dizin/dosya için izin (güvenlik tanımlayıcısı) ayarlanmalıdır. İzin boyutu = 8 KB ise bu <üst bilgi kullanılabilir, aksi takdirde file-permission-key üst bilgisi kullanılır. Varsayılan değer: Devral. Giriş olarak SDDL belirtilirse sahip, grup ve dacl olmalıdır. Not: Dosya-izni veya dosya-izni-anahtarından yalnızca biri belirtilmelidir.

file_permission_key

str

Dizin/dosya için ayarlanacak iznin anahtarı. Not: Dosya-izni veya dosya-izni-anahtarından yalnızca biri belirtilmelidir.

file_change_time

str veya datetime

Dizinin süresini değiştirin. Belirtilmezse, değişiklik saati geçerli tarih/saat olarak ayarlanır.

Sürüm 12.8.0'da yeni eklendi: Bu parametre '2021-06-08' API sürümünde kullanıma sunulmuştur.

metadata

dict(str,str)

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

Dizin tarafından güncelleştirilmiş özellik diktesi (Etag ve son değiştirme).

Dönüş türü

dict(str, Any)

Örnekler

Bir dizin oluşturur.

   my_directory.create_directory()

create_subdirectory

Yeni bir alt dizin oluşturur ve alt dizinle etkileşime geçmek için bir istemci döndürür.

create_subdirectory(directory_name: str, **kwargs) -> ShareDirectoryClient

Parametreler

directory_name

str

Gerekli

Alt dizinin adı.

metadata

dict(str,str)

Alt 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 izlenmiyor veya doğrulanmıyor. İstemci tarafı ağ zaman aşımlarını yapılandırmak için buraya bakın.

Döndürülenler

ShareDirectoryClient

Dönüş türü

ShareDirectoryClient

Örnekler

Bir alt dizin oluşturun.

   # Create the directory
   parent_dir.create_directory()

   # Create a subdirectory
   subdir = parent_dir.create_subdirectory("subdir")

delete_directory

Dizini silinmek üzere işaretler. Dizin daha sonra çöp toplama sırasında silinir.

delete_directory(**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 izlenmiyor veya doğrulanmıyor. İstemci tarafı ağ zaman aşımlarını yapılandırmak için buraya bakın.

Dönüş türü

None

Örnekler

Bir dizini siler.

   my_directory.delete_directory()

delete_file

Belirtilen dosyayı silinmek üzere işaretler. Dosya daha sonra çöp toplama sırasında silinir.

delete_file(file_name: str, **kwargs: Any | None) -> None

Parametreler

file_name

str

Gerekli

Silinecek dosyanın adı.

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 izlenmiyor veya doğrulanmıyor. İstemci tarafı ağ zaman aşımlarını yapılandırmak için buraya bakın.

Dönüş türü

None

Örnekler

Dizindeki bir dosyayı silin.

   # Delete the file in the directory
   my_directory.delete_file(file_name="sample")

delete_subdirectory

Bir alt dizini siler.

delete_subdirectory(directory_name: str, **kwargs) -> None

Parametreler

directory_name

str

Gerekli

Alt dizinin adı.

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 izlenmiyor veya doğrulanmıyor. İstemci tarafı ağ zaman aşımlarını yapılandırmak için buraya bakın.

Dönüş türü

None

Örnekler

Bir alt dizini silin.

   parent_dir.delete_subdirectory("subdir")

exists

Bir dizin varsa True döndürür ve aksi takdirde False döndürür.

exists(**kwargs: Any) -> bool

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 izlenmiyor veya doğrulanmıyor. İstemci tarafı ağ zaman aşımlarını yapılandırmak için buraya bakın.

Döndürülenler

Dizin varsa True, aksi takdirde False.

Dönüş türü

bool

from_connection_string

Bağlantı Dizesinden ShareDirectoryClient oluşturun.

from_connection_string(conn_str: str, share_name: str, directory_path: str, credential: str | Dict[str, str] | AzureNamedKeyCredential | AzureSasCredential | TokenCredential | None = None, **kwargs: Any) -> Self

Parametreler

conn_str

str

Gerekli

Azure Depolama hesabına bağlantı dizesi.

share_name

str

Gerekli

Paylaşımın adı.

directory_path

str

Gerekli

Dizin yolu.

credential

varsayılan değer: None

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 açık bir kimlik bilgisi için yoksayılır

• ancak çakışan SAS belirteçlerinin bir ValueError oluşturacağı AzureSasCredential durumu dışında. AzureNamedKeyCredential örneği kullanılıyorsa depolama hesabı adı "name" ve depolama hesabı anahtarı "anahtar" olmalıdır.

audience

str

Azure Active Directory kimlik doğrulaması için belirteçler istenirken kullanılacak hedef kitle. Yalnızca kimlik bilgisi TokenCredential türünde olduğunda bir etkiye sahiptir. Değer (varsayılan) veya https://.file.core.windows.net olabilir https://storage.azure.com/ .

Döndürülenler

Dizin istemcisi.

Dönüş türü

ShareDirectoryClient

from_directory_url

Dizin url'sinden ShareDirectoryClient oluşturun.

from_directory_url(directory_url: str, snapshot: str | Dict[str, Any] | None = None, credential: str | Dict[str, str] | AzureNamedKeyCredential | AzureSasCredential | TokenCredential | None = None, **kwargs: Any) -> Self

Parametreler

directory_url

str

Gerekli

Dizinin tam URI'sini.

snapshot

str

varsayılan değer: None

Ü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 içinden create_snapshotdöndürülen yanıt olabilir.

credential

varsayılan değer: None

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 açık bir kimlik bilgisi için yoksayılır

• ancak çakışan SAS belirteçlerinin bir ValueError oluşturacağı AzureSasCredential durumu dışında. AzureNamedKeyCredential örneği kullanılıyorsa depolama hesabı adı "name" ve depolama hesabı anahtarı "anahtar" olmalıdır.

audience

str

Azure Active Directory kimlik doğrulaması için belirteçler istenirken kullanılacak hedef kitle. Yalnızca kimlik bilgisi TokenCredential türünde olduğunda bir etkiye sahiptir. Değer (varsayılan) veya https://.file.core.windows.net olabilir https://storage.azure.com/ .

Döndürülenler

Dizin istemcisi.

Dönüş türü

ShareDirectoryClient

get_directory_properties

Belirtilen dizin için tüm kullanıcı tanımlı meta verileri ve sistem özelliklerini döndürür. Döndürülen veriler dizinin dosya listesini içermez.

get_directory_properties(**kwargs: Any) -> DirectoryProperties

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 izlenmiyor veya doğrulanmıyor. İstemci tarafı ağ zaman aşımlarını yapılandırmak için buraya bakın.

Döndürülenler

DirectoryProperties

Dönüş türü

DirectoryProperties

get_file_client

İstemcinin belirli bir dosyayla etkileşim kurmasını sağlayın.

Dosya zaten mevcut değil.

get_file_client(file_name: str, **kwargs: Any) -> ShareFileClient

Parametreler

file_name

str

Gerekli

Dosyanın adı.

Döndürülenler

Dosya İstemcisi.

Dönüş türü

ShareFileClient

get_subdirectory_client

İstemcinin belirli bir alt dizinle etkileşim kurmasını sağlayın.

Alt dizinin zaten mevcut olması gerekmez.

get_subdirectory_client(directory_name: str, **kwargs: Any) -> ShareDirectoryClient

Parametreler

directory_name

str

Gerekli

Alt dizinin adı.

Döndürülenler

Dizin İstemcisi.

Dönüş türü

ShareDirectoryClient

Örnekler

Alt dizin istemcisini alır.

   # Get a directory client and create the directory
   parent = share.get_directory_client("dir1")
   parent.create_directory()

   # Get a subdirectory client and create the subdirectory "dir1/dir2"
   subdirectory = parent.get_subdirectory_client("dir2")
   subdirectory.create_directory()

list_directories_and_files

Dizinin altındaki tüm dizinleri ve dosyaları listeler.

list_directories_and_files(name_starts_with: str | None = None, **kwargs: Any) -> ItemPaged

Parametreler

name_starts_with

str

Gerekli

Sonuçları yalnızca adları belirtilen ön ek ile başlayan varlıkları döndürecek şekilde filtreler.

include

list[str]

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 kullanıma 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 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 izlenmiyor veya doğrulanmıyor. İstemci tarafı ağ zaman aşımlarını yapılandırmak için buraya bakın.

Döndürülenler

Dikte benzeri DirectoryProperties ve FileProperties için otomatik sayfalama yinelenebilirliği

Dönüş türü

ItemPaged[DirectoryProperties <xref:and> FileProperties]

Örnekler

Dizinleri ve dosyaları listeleyin.

   # List the directories and files under the parent directory
   my_list = list(parent_dir.list_directories_and_files())
   print(my_list)

list_handles

Dizindeki veya dizinin altındaki bir dosyadaki açık tanıtıcıları listeler.

list_handles(recursive: bool = False, **kwargs: Any) -> ItemPaged[Handle]

Parametreler

recursive

bool

Gerekli

İşlemin istemci tarafından belirtilen dizine, dosyalarına, alt dizinlerine ve dosyalarına uygulanıp uygulanacağını belirten Boole değeri. Varsayılan değerdir False’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 izlenmiyor veya doğrulanmıyor. İstemci tarafı ağ zaman aşımlarını yapılandırmak için buraya bakın.

Döndürülenler

Tanıtıcının otomatik disk belleği yinelenebilir bir

Dönüş türü

ItemPaged[Handle]

rename_directory

Kaynak dizini yeniden adlandırın.

:p aramtype file_attributes:~azure.storage.fileshare.NTFSAttributes veya str :keyword file_creation_time:

Dizin için oluşturma zamanı.

:p aramtype file_creation_time:~datetime.datetime veya str :keyword file_last_write_time:

Dosya için son yazma zamanı.

:p aramtype file_last_write_time:~datetime.datetime veya str :keyword file_change_time:

Dizinin süresini değiştirin. Belirtilmezse, değişiklik saati geçerli tarih/saat olarak ayarlanır.

Sürüm 12.8.0'da yeni eklendi: Bu parametre '2021-06-08' API sürümünde kullanıma sunulmuştur.

rename_directory(new_name: str, **kwargs: Any) -> ShareDirectoryClient

Parametreler

metadata

Dict[str,str]

Dosya depolama nesnesiyle ilişkilendirilecek bir ad-değer çifti.

destination_lease

ShareLeaseClient veya str

Hedef dosyanın etkin bir kirası varsa gereklidir. Değer bir ShareLeaseClient nesnesi veya dize olarak kira kimliği olabilir.

Döndürülenler

Yeni Dizin İstemcisi.

Dönüş türü

ShareDirectoryClient

set_directory_metadata

Dizinin meta verilerini ayarlar.

Bu işleme yapılan her çağrı, dizinine eklenmiş olan tüm meta verilerin yerini alır. Dizindeki tüm meta verileri kaldırmak için bu işlemi boş bir meta veri diktesi ile çağırın.

set_directory_metadata(metadata: Dict[str, Any], **kwargs: Any) -> Dict[str, Any]

Parametreler

metadata

dict(str, str)

Gerekli

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

Dizin tarafından güncelleştirilmiş özellik diktesi (Etag ve son değiştirme).

Dönüş türü

dict(str, Any)

set_http_headers

Dizinde HTTP üst bilgilerini ayarlar.

set_http_headers(file_attributes: str | NTFSAttributes = 'none', file_creation_time: str | datetime | None = 'preserve', file_last_write_time: str | datetime | None = 'preserve', file_permission: str | None = None, permission_key: str | None = None, **kwargs: Any) -> Dict[str, Any]

Parametreler

file_attributes

NTFSAttributes

Gerekli

Dosyalar ve dizinler için dosya sistemi öznitelikleri. Ayarlanmadıysa, mevcut değerlerin korunmasını gösterir. Burada, var türünün ne zaman str olduğuna ilişkin bir örnek verilmiştir: 'Geçici|Arşivle'

file_creation_time

str veya datetime

Gerekli

Dosya için oluşturma zamanı Varsayılan değer: Koru.

file_last_write_time

str veya datetime

Gerekli

Dosya için son yazma zamanı Varsayılan değer: Koru.

file_permission

str

Gerekli

Belirtilirse, dizin/dosya için izin (güvenlik tanımlayıcısı) ayarlanmalıdır. İzin boyutu = 8 KB ise bu <üst bilgi kullanılabilir, aksi takdirde x-ms-file-permission-key üst bilgisi kullanılır. Varsayılan değer: Devral. Giriş olarak SDDL belirtilirse sahip, grup ve dacl olmalıdır. Not: Yalnızca bir x-ms-file-permission veya x-ms-file-permission-key belirtilmelidir.

permission_key

str

Gerekli

Dizin/dosya için ayarlanacak iznin anahtarı. Not: Yalnızca bir x-ms-file-permission veya x-ms-file-permission-key belirtilmelidir.

file_change_time

str veya datetime

Dizinin süresini değiştirin. Belirtilmezse, değişiklik saati geçerli tarih/saat olarak ayarlanır.

Sürüm 12.8.0'da yeni eklendi: Bu parametre '2021-06-08' 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.

Döndürülenler

Dosya güncelleştirilmiş özellik diktesi (Etag ve son değiştirme).

Dönüş türü

dict(str, Any)

upload_file

Dizininde yeni bir dosya oluşturur ve dosyayla etkileşime geçmek için bir ShareFileClient döndürür.

upload_file(file_name: str, data: bytes | str | Iterable | IO, length: int | None = None, **kwargs) -> ShareFileClient

Parametreler

file_name

str

Gerekli

Dosyanın adı.

data

Gerekli

Dosyanın içeriği.

length

int

Gerekli

Dosyanın bayt cinsinden uzunluğu. Maksimum boyutunu 1 TiB'a kadar belirtin.

metadata

dict(str,str)

Dosyayla meta veri olarak ilişkili ad-değer çiftleri.

content_settings

ContentSettings

Dosya özelliklerini ayarlamak için kullanılan ContentSettings nesnesi. İçerik türü, kodlama, dil, bırakma, md5 ve önbellek denetimini ayarlamak için kullanılır.

validate_content

bool

True ise, dosyanın her aralığı için bir MD5 karması hesaplar. Depolama hizmeti, gönderilen karma ile gelen içeriğin karması denetler. Https (varsayılan) olarak https yerine http kullanıldığında zaten doğrulanacaksa bu, kablodaki bitflip'leri algılamak için öncelikli olarak değerlidir. Bu MD5 karması dosyayla birlikte depolanmaz.

max_concurrency

int

Kullanılacak en fazla paralel bağlantı sayısı.

progress_hook

Callable[[int, Optional[int]], None]

Uzun süre çalışan bir karşıya yükleme işleminin ilerleme durumunu izlemek için geri çağırma. İmza function(current: int, total: Optional[int]) şeklindedir; burada geçerli, şu ana kadar aktarılan bayt sayısıdır ve toplam blobun boyutudur veya boyut bilinmiyorsa Yok olur.

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.

encoding

str

Varsayılan olarak UTF-8'i kullanır.

Döndürülenler

ShareFileClient

Dönüş türü

ShareFileClient

Örnekler

Bir dizine dosya yükleyin.

   # Upload a file to the directory
   with open(SOURCE_FILE, "rb") as source:
       my_directory.upload_file(file_name="sample", data=source)

Ö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

ValueError

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