ShareFileClient Sınıf

Belirli bir dosyayla etkileşime geçmek için bir istemci, ancak bu dosya henüz var olmayabilir.

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
ShareFileClient

Oluşturucu

ShareFileClient(account_url: str, share_name: str, file_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. Dosyaya tam URI verilen bir istemci oluşturmak için classmethod kullanın from_file_url .

share_name
str
Gerekli

Dosyanın paylaşımının adı.

file_path
str
Gerekli

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

snapshot
str
varsayılan değer: None

Üzerinde çalışılan isteğe bağlı bir dosya 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

abort_copy

Devam eden kopyalama işlemini iptal edin.

Bu, sıfır uzunlukta ve tam meta veri içeren bir hedef dosya bırakır. Kopyalama işlemi zaten sona erdiyse bu bir hataya neden olur.

acquire_lease

Yeni kiralama isteğinde bulunur.

Dosyanın etkin kiralaması yoksa, Dosya Hizmeti blob üzerinde bir kira oluşturur ve yeni bir kira döndürür.

clear_range

Belirtilen aralığı temizler ve bu aralık için depolama alanında kullanılan alanı serbest bırakı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_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 tutamacını kapatın.

create_file

Yeni bir dosya oluşturur.

Dosyanın yalnızca içerik olmadan başlatıldığını unutmayın.

delete_file

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

download_file

StorageStreamDownloader'a bir dosya indirir. Readall() yöntemi tüm içeriği okumak için kullanılmalıdır veya dosyayı akışa indirmek için readinto() kullanılmalıdır. chunks() kullanmak, kullanıcının öbeklerdeki içerik üzerinde yineleme yapmasına olanak tanıyan bir yineleyici döndürür.

from_connection_string

Bağlantı Dizesinden ShareFileClient oluşturun.

from_file_url

Belirli bir dosyayla etkileşime geçmek için bir istemci, ancak bu dosya henüz var olmayabilir.

get_file_properties

Dosya için tüm kullanıcı tanımlı meta verileri, standart HTTP özelliklerini ve sistem özelliklerini döndürür.

get_ranges

Bir dosyanın veya bir dosyanın anlık görüntüsünün geçerli sayfa aralıklarının listesini döndürür.

get_ranges_diff

Bir dosyanın veya bir dosyanın anlık görüntüsünün geçerli sayfa aralıklarının listesini döndürür.

Sürüm 12.6.0'da yeni.

list_handles

Dosya tanıtıcılarını listeler.

rename_file

Kaynak dosyayı yeniden adlandırın.

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

Dosya 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:

Dosyanın 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.

resize_file

Bir dosyayı belirtilen boyuta yeniden boyutlandırıyor.

set_file_metadata

Belirtilen dosya için kullanıcı tanımlı meta verileri bir veya daha fazla ad-değer çifti olarak ayarlar.

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

set_http_headers

Dosyada HTTP üst bilgilerini ayarlar.

start_copy_from_url

Bir kaynak URL'den istemci tarafından başvuruda bulunılan dosyaya veri kopyalamayı başlatır.

Bu kopyalama işleminin durumu get_properties yöntemi kullanılarak bulunabilir.

upload_file

Yeni bir dosyayı karşıya yükler.

param verileri: Dosyanın içeriği.

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

param file_attributes: 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_attributes yazın: str veya ~azure.storage.fileshare.NTFSAttributes

param file_creation_time: Dosya için oluşturma zamanı Varsayılan değer: Şimdi.

file_creation_time yazın: str veya ~datetime.datetime

param file_last_write_time: Dosya için son yazma zamanı Varsayılan değer: Şimdi.

file_last_write_time yazın: str veya ~datetime.datetime

param file_permission: 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.

tür file_permission: str

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

type permission_key: str

upload_range

Dosyaya bir bayt aralığı yükleyin.

upload_range_from_url

Bir Azure Dosya uç noktasındaki baytları başka bir Azure Dosya uç noktasının belirtilen aralığına yazar.

abort_copy

Devam eden kopyalama işlemini iptal edin.

Bu, sıfır uzunlukta ve tam meta veri içeren bir hedef dosya bırakır. Kopyalama işlemi zaten sona erdiyse bu bir hataya neden olur.

abort_copy(copy_id: str | FileProperties, **kwargs: Any) -> None

Parametreler

copy_id
str veya FileProperties
Gerekli

Durdurulacak kopyalama işlemi. Bu bir kimlik veya FileProperties örneği olabilir.

lease
ShareLeaseClient veya str

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

Sürüm 12.1.0'da yeni.

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ü

acquire_lease

Yeni kiralama isteğinde bulunur.

Dosyanın etkin kiralaması yoksa, Dosya Hizmeti blob üzerinde bir kira oluşturur ve yeni bir kira döndürür.

acquire_lease(lease_id: str | None = None, **kwargs: Any) -> ShareLeaseClient

Parametreler

lease_id
str
Gerekli

GUID dize biçiminde önerilen kira kimliği. Önerilen kira kimliği doğru biçimde değilse Dosya 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 dosyada kira alma.


   source_file.create_file(1024)
   lease = source_file.acquire_lease()
   source_file.upload_file(b'hello world', lease=lease)

   lease.release()

clear_range

Belirtilen aralığı temizler ve bu aralık için depolama alanında kullanılan alanı serbest bırakır.

clear_range(offset: int, length: int, **kwargs) -> Dict[str, Any]

Parametreler

offset
int
Gerekli

Dosyanın bir bölümünü temizlemek için kullanılacak bayt aralığının başlangıcı. Aralığın boyutu 4 MB'a kadar olabilir.

length
int
Gerekli

Dosyanın bir bölümünü temizlemek için kullanılacak bayt sayısı. Aralığın boyutu 4 MB'a kadar olabilir.

lease
ShareLeaseClient veya str

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

Sürüm 12.1.0'da yeni.

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ü

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(**kwargs: Any) -> Dict[str, 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.

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ü

close_handle

Açık bir dosya tutamacı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ü

create_file

Yeni bir dosya oluşturur.

Dosyanın yalnızca içerik olmadan başlatıldığını unutmayın.

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

Parametreler

size
int
Gerekli

Dosya için en fazla 1 TB boyutu belirtir.

file_attributes
NTFSAttributes
Gerekli

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 olduğuyla ilgili 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
Gerekli

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

file_last_write_time
str veya datetime
Gerekli

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

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. SDDL giriş olarak belirtilirse sahibi, grubu ve dacl'sı olmalıdır. Not: x-ms-file-permission veya x-ms-file-permission-key yalnızca biri belirtilmelidir.

permission_key
str
Gerekli

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

file_change_time
str veya datetime

Dosyanın 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.

content_settings
ContentSettings

Dosya özelliklerini ayarlamak için kullanılan ContentSettings nesnesi. İçerik türünü, kodlamayı, dili, eğilimi, md5'i ve önbellek denetimini ayarlamak için kullanılır.

metadata
dict(str,str)

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

lease
ShareLeaseClient veya str

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

Sürüm 12.1.0'da yeni.

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

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

Dönüş türü

Örnekler

Bir dosya oluşturun.


   # Create and allocate bytes for the file (no content added yet)
   my_allocated_file.create_file(size=100)

delete_file

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

delete_file(**kwargs: Any) -> None

Parametreler

lease
ShareLeaseClient veya str

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

Sürüm 12.1.0'da yeni.

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ü

Örnekler

Bir dosyayı silin.


   my_file.delete_file()

download_file

StorageStreamDownloader'a bir dosya indirir. Readall() yöntemi tüm içeriği okumak için kullanılmalıdır veya dosyayı akışa indirmek için readinto() kullanılmalıdır. chunks() kullanmak, kullanıcının öbeklerdeki içerik üzerinde yineleme yapmasına olanak tanıyan bir yineleyici döndürür.

download_file(offset: int | None = None, length: int | None = None, **kwargs: Any) -> StorageStreamDownloader

Parametreler

offset
int
Gerekli

Dosyanın bir bölümünü indirmek için kullanılacak bayt aralığının başlangıcı. Uzunluk sağlanmışsa ayarlanmalıdır.

length
int
Gerekli

Akıştan okunacak bayt sayısı. Bu isteğe bağlıdır, ancak en iyi performans için sağlanmalıdır.

max_concurrency
int

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

validate_content
bool

True ise, dosyanın her bir öbeği için bir MD5 karması hesaplar. Depolama hizmeti, gönderilen karma ile gelen içeriğin karması denetler. Https yerine http kullanıldığında (varsayılan) zaten doğrulanacaksa, bu öncelikle kablodaki bitflip'leri algılamak için değerlidir. Bu MD5 karması dosyayla birlikte depolanmaz. Ayrıca etkinleştirilirse bellek açısından verimli karşıya yükleme algoritmasının kullanılmayacağını unutmayın çünkü MD5 karması hesaplaması blokların tamamını arabelleğe almayı gerektirir ve bunu yapmak bellek açısından verimli algoritmanın amacını alt eder.

lease
ShareLeaseClient veya str

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

Sürüm 12.1.0'da yeni.

progress_hook
Callable[[int, int], None]

Uzun süre çalışan bir indirme işleminin ilerleme durumunu izlemek için geri arama. İmza işlevidir (current: int, total: int), burada geçerli, şimdiye kadar aktarılan bayt sayısı ve toplam indirmenin toplam boyutudur.

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

Akış nesnesi (StorageStreamDownloader)

Dönüş türü

<xref:azure.storage.fileshare.StorageStreamDownloader>

Örnekler

Bir dosya indirin.


   with open(DEST_FILE, "wb") as data:
       stream = my_file.download_file()
       data.write(stream.readall())

from_connection_string

Bağlantı Dizesinden ShareFileClient oluşturun.

from_connection_string(conn_str: str, share_name: str, file_path: str, snapshot: str | Dict[str, Any] | None = None, 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ı.

file_path
str
Gerekli

Dosya yolu.

snapshot
str
varsayılan değer: None

Üzerinde çalışılan isteğe bağlı bir dosya 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

Dosya istemcisi.

Dönüş türü

Örnekler

dosya istemcisini bağlantı dizesi ile oluşturur.


   from azure.storage.fileshare import ShareFileClient
   file = ShareFileClient.from_connection_string(
       self.connection_string,
       share_name="helloworld2",
       file_path="myfile")

from_file_url

Belirli bir dosyayla etkileşime geçmek için bir istemci, ancak bu dosya henüz var olmayabilir.

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

Parametreler

file_url
str
Gerekli

Dosyanın tam URI'sini.

snapshot
str
varsayılan değer: None

Üzerinde çalışılan isteğe bağlı bir dosya 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

Dosya istemcisi.

Dönüş türü

get_file_properties

Dosya için tüm kullanıcı tanımlı meta verileri, standart HTTP özelliklerini ve sistem özelliklerini döndürür.

get_file_properties(**kwargs: Any) -> FileProperties

Parametreler

lease
ShareLeaseClient veya str

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

Sürüm 12.1.0'da yeni.

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

FileProperties

Dönüş türü

get_ranges

Bir dosyanın veya bir dosyanın anlık görüntüsünün geçerli sayfa aralıklarının listesini döndürür.

get_ranges(offset: int | None = None, length: int | None = None, **kwargs: Any) -> List[Dict[str, int]]

Parametreler

offset
int
Gerekli

Aralıkların alındığı baytların başlangıç uzaklığını belirtir.

length
int
Gerekli

Aralıkların alındığı kullanılacak bayt sayısı.

lease
ShareLeaseClient veya str

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

Sürüm 12.1.0'da yeni.

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

Geçerli aralıkların listesi.

Dönüş türü

get_ranges_diff

Bir dosyanın veya bir dosyanın anlık görüntüsünün geçerli sayfa aralıklarının listesini döndürür.

Sürüm 12.6.0'da yeni.

get_ranges_diff(previous_sharesnapshot: str | Dict[str, Any], offset: int | None = None, length: int | None = None, **kwargs: Any) -> Tuple[List[Dict[str, int]], List[Dict[str, int]]]

Parametreler

offset
int
Gerekli

Aralıkların alındığı baytların başlangıç uzaklığını belirtir.

length
int
Gerekli

Aralıkların alındığı kullanılacak bayt sayısı.

previous_sharesnapshot
str
Gerekli

Daha yeni bir anlık görüntüyle veya geçerli dosyayla karşılaştırılacak önceki bir dosya anlık görüntüsünü belirten opak bir DateTime değeri içeren snapshot diff parametresi.

lease
ShareLeaseClient veya str

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

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

'start' ve 'end' anahtarlarına sahip sözlükler olarak iki dosya aralığı listesi. İlk öğe doldurulmuş dosya aralıklarıdır, 2. öğe dosya aralıkları temizlenir.

Dönüş türü

list_handles

Dosya tanıtıcılarını listeler.

list_handles(**kwargs: Any) -> ItemPaged[Handle]

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

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

Dönüş türü

rename_file

Kaynak dosyayı yeniden adlandırın.

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

Dosya 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:

Dosyanın 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_file(new_name: str, **kwargs: Any) -> ShareFileClient

Parametreler

content_type
str

Yeni dosyanın İçerik Tü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]

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

source_lease
ShareLeaseClient veya str

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

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 Dosya İstemcisi.

Dönüş türü

resize_file

Bir dosyayı belirtilen boyuta yeniden boyutlandırıyor.

resize_file(size: int, **kwargs: Any) -> Dict[str, Any]

Parametreler

size
int
Gerekli

Dosyayı yeniden boyutlandıracak boyut (bayt cinsinden)

lease
ShareLeaseClient veya str

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

Sürüm 12.1.0'da yeni.

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ü

set_file_metadata

Belirtilen dosya için kullanıcı tanımlı meta verileri bir veya daha fazla ad-değer çifti olarak ayarlar.

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

set_file_metadata(metadata: Dict[str, Any] | None = None, **kwargs: Any) -> Dict[str, Any]

Parametreler

metadata
dict(str, str)
Gerekli

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

lease
ShareLeaseClient veya str

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

Sürüm 12.1.0'da yeni.

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ü

set_http_headers

Dosyada HTTP üst bilgilerini ayarlar.

set_http_headers(content_settings: ContentSettings, file_attributes: str | NTFSAttributes = 'preserve', 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

content_settings
ContentSettings
Gerekli

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.

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

Dosyanın 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.

lease
ShareLeaseClient veya str

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

Sürüm 12.1.0'da yeni.

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ü

start_copy_from_url

Bir kaynak URL'den istemci tarafından başvuruda bulunılan dosyaya veri kopyalamayı başlatır.

Bu kopyalama işleminin durumu get_properties yöntemi kullanılarak bulunabilir.

start_copy_from_url(source_url: str, **kwargs: Any) -> Any

Parametreler

source_url
str
Gerekli

Kaynak dosyanın URL'sini belirtir.

file_permission
str

Belirtilirse, dizin/dosya için izin (güvenlik tanımlayıcısı) ayarlanmalıdır. Bu değer, kaynak dosyadan güvenlik tanımlayıcısını kopyalamak için "kaynak" olarak ayarlanabilir. Aksi takdirde, bu değer kaynak değeri geçersiz kılmak için kullanılır. Ayarlanmamışsa, izin değeri hedef dosyanın üst dizininden devralınır. İzin boyutu = 8 KB ise bu <ayar kullanılabilir, aksi takdirde permission_key kullanılır. Giriş olarak SDDL belirtilirse sahip, grup ve dacl olmalıdır. Not: file_permission veya permission_key yalnızca biri belirtilmelidir.

Sürüm 12.1.0'da yeni eklendi: Bu parametre '2019-07-07' API sürümünde kullanıma sunulmuştur.

permission_key
str

Dizin/dosya için ayarlanacak iznin anahtarı. Bu değer, kaynak dosyadan güvenlik tanımlayıcısını kopyalamak için "kaynak" olarak ayarlanabilir. Aksi takdirde, bu değer kaynak değeri geçersiz kılmak için kullanılır. Ayarlanmamışsa, izin değeri hedef dosyanın üst dizininden devralınır. Not: file_permission veya permission_key yalnızca biri belirtilmelidir.

Sürüm 12.1.0'da yeni eklendi: Bu parametre '2019-07-07' API sürümünde kullanıma sunulmuştur.

file_attributes
NTFSAttributes

Bu değer, kaynak dosyadan hedef dosyaya dosya özniteliklerini kopyalamak için "kaynak" olarak ayarlanabilir veya tüm öznitelikleri temizlemek için "Yok" olarak ayarlanabilir. Aksi takdirde, hedef dosyada ayarlanacak öznitelikler listesine ayarlanabilir. Bu ayarlanmadıysa, varsayılan değer "Arşiv" olur.

Sürüm 12.1.0'da yeni eklendi: Bu parametre '2019-07-07' API sürümünde kullanıma sunulmuştur.

file_creation_time
str veya datetime

Bu değer, oluşturma zamanını kaynak dosyadan hedef dosyaya kopyalamak için "kaynak" olarak veya hedef dosyada oluşturma zamanı olarak ayarlanacak bir tarih saat olarak ayarlanabilir. Bu, ISO 8601 biçiminde bir dize de olabilir. Bu ayar yapılmazsa, oluşturma zamanı, kopyalama altyapısı tarafından hedef dosyanın oluşturulma (veya üzerine yazıldığı) tarih saat değerine ayarlanır.

Sürüm 12.1.0'da yeni eklendi: Bu parametre '2019-07-07' API sürümünde kullanıma sunulmuştur.

file_last_write_time
str veya datetime

Bu değer, kaynak dosyadan hedef dosyaya son yazma zamanını kopyalamak için "kaynak" olarak veya hedef dosyada son yazma zamanı olarak ayarlanacak bir tarih saat olarak ayarlanabilir. Bu, ISO 8601 biçiminde bir dize de olabilir. Bu ayarlanmadıysa, değer kopya altyapısı tarafından dosyaya son yazma zamanı olur.

Sürüm 12.1.0'da yeni eklendi: Bu parametre '2019-07-07' API sürümünde kullanıma sunulmuştur.

file_change_time
str veya datetime

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

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

ignore_read_only
bool

Zaten varsa ve salt okunur öznitelik ayarlanmışsa hedef dosyanın üzerine yazma seçeneğini belirtir.

Sürüm 12.1.0'da yeni eklendi: Bu parametre '2019-07-07' API sürümünde kullanıma sunulmuştur.

set_archive_attribute
bool

Hedef dosyada arşiv özniteliğini ayarlama seçeneğini belirtir. True, öznitelik geçersiz kılmalarına veya kaynak dosya durumuna rağmen arşiv özniteliğinin hedef dosyada ayarlanacağı anlamına gelir.

Sürüm 12.1.0'da yeni eklendi: Bu parametre '2019-07-07' API sürümünde kullanıma sunulmuştur.

metadata

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

lease
ShareLeaseClient veya str

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

Sürüm 12.1.0'da yeni.

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ü

Örnekler

URL'den dosya kopyalama


   destination_file.start_copy_from_url(source_url=source_url)

upload_file

Yeni bir dosyayı karşıya yükler.

param verileri: Dosyanın içeriği.

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

param file_attributes: 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_attributes yazın: str veya ~azure.storage.fileshare.NTFSAttributes

param file_creation_time: Dosya için oluşturma zamanı Varsayılan değer: Şimdi.

file_creation_time yazın: str veya ~datetime.datetime

param file_last_write_time: Dosya için son yazma zamanı Varsayılan değer: Şimdi.

file_last_write_time yazın: str veya ~datetime.datetime

param file_permission: 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.

tür file_permission: str

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

type permission_key: str

upload_file(data: bytes | str | Iterable | IO, length: int | None = None, file_attributes: str | NTFSAttributes = 'none', file_creation_time: str | datetime | None = 'now', file_last_write_time: str | datetime | None = 'now', file_permission: str | None = None, permission_key: str | None = None, **kwargs) -> Dict[str, Any]

Parametreler

file_change_time

Dosyanın 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.

paramtype file_change_time: str veya ~datetime.datetime

anahtar sözcük dict(str,str) meta verileri: Dosyayla meta veri olarak ilişkili ad-değer çiftleri.

anahtar sözcüğü ~azure.storage.fileshare.ContentSettings content_settings: 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.

anahtar sözcük bool validate_content: 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.

anahtar sözcük int max_concurrency: Kullanılacak en fazla paralel bağlantı sayısı.

anahtar sözcük kirası: Dosyanın etkin bir kirası varsa gereklidir. Değer bir ShareLeaseClient nesnesi veya dize olarak kira kimliği olabilir.

Sürüm 12.1.0'da yeni.

paramtype kirası: ~azure.storage.fileshare.ShareLeaseClient veya str

anahtar sözcük progress_hook: Uzun süre çalışan bir karşıya yüklemenin ilerleme durumunu izlemek için bir 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.

paramtype progress_hook: Callable[[int, Optional[int]], None]

anahtar sözcük int zaman aşımı: İş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.

anahtar sözcük str kodlaması: Varsayılan olarak UTF-8'i kullanır.

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

rtype: dict(str, Any)

Örnek:Bir dosyayı karşıya yükleyin.


   with open(SOURCE_FILE, "rb") as source:
       my_file.upload_file(source)

upload_range

Dosyaya bir bayt aralığı yükleyin.

upload_range(data: bytes, offset: int, length: int, **kwargs) -> Dict[str, Any]

Parametreler

data
bytes
Gerekli

Karşıya yüklenecek veriler.

offset
int
Gerekli

Dosyanın bir bölümünü karşıya yüklemek için kullanılacak bayt aralığının başlangıcı. Aralığın boyutu 4 MB'a kadar olabilir.

length
int
Gerekli

Dosyanın bir bölümünü karşıya yüklemek için kullanılacak bayt sayısı. Aralığın boyutu 4 MB'a kadar olabilir.

validate_content
bool

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

file_last_write_mode
Literal["preserve", "now"]

Dosyanın son yazma zamanının korunması veya üzerine yazılması gerekiyorsa. Olası değerler "preserve" veya "now" şeklindedir. Belirtilmezse, dosya son yazma saati geçerli tarih/saat olarak değiştirilir.

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

lease
ShareLeaseClient veya str

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

Sürüm 12.1.0'da yeni.

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.

encoding
str

Varsayılan olarak UTF-8'e ayarlanır.

Döndürülenler

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

Dönüş türü

upload_range_from_url

Bir Azure Dosya uç noktasındaki baytları başka bir Azure Dosya uç noktasının belirtilen aralığına yazar.

upload_range_from_url(source_url: str, offset: int, length: int, source_offset: int, **kwargs: Any) -> Dict[str, Any]

Parametreler

offset
int
Gerekli

Dosyanın bir bölümünü güncelleştirmek için kullanılacak bayt aralığının başlangıcı. Aralığın boyutu 4 MB'a kadar olabilir.

length
int
Gerekli

Dosyanın bir bölümünü güncelleştirmek için kullanılacak bayt sayısı. Aralığın boyutu 4 MB'a kadar olabilir.

source_url
str
Gerekli

Azure dosyasını veya blobu belirten en fazla 2 KB uzunluğunda bir URL. Değer, istek URI'sinde göründüğü gibi URL ile kodlanmış olmalıdır. Kaynak başka bir hesaptaysa, kaynağın ortak olması veya paylaşılan erişim imzası aracılığıyla kimliğinin doğrulanması gerekir. Kaynak genelse kimlik doğrulaması gerekmez. Örnekler: https://myaccount.file.core.windows.net/myshare/mydir/myfilehttps://otheraccount.file.core.windows.net/myshare/mydir/myfile?sastoken

source_offset
int
Gerekli

Bu, kopyalama kaynağından alınması gereken bayt aralığının (dahil) başlangıcını gösterir. Hizmet, hedef aralıkla (uzunluk uzaklığı) aynı sayıda bayt okur.

source_if_modified_since
datetime

Bir DateTime değeri. Azure, geçirilen tarih değerinin UTC olmasını bekler. Saat dilimi dahil edilirse, UTC olmayan tarih saatleri UTC'ye dönüştürülür. Saat dilimi bilgisi olmadan bir tarih geçirilirse UTC olduğu varsayılır. Blobu kopyalamak için yalnızca kaynak blob belirtilen tarih/saatten sonra değiştirilmişse bu koşullu üst bilgiyi belirtin.

source_if_unmodified_since
datetime

Bir DateTime değeri. Azure, geçirilen tarih değerinin UTC olmasını bekler. Saat dilimi dahil edilirse, UTC olmayan tarih saatleri UTC'ye dönüştürülür. Saat dilimi bilgisi olmadan bir tarih geçirilirse UTC olduğu varsayılır. Blobu kopyalamak için bu koşullu üst bilgiyi yalnızca kaynak blob belirtilen tarih/saatten sonra değiştirilmediyse belirtin.

source_etag
str

Kaynak ETag değeri veya joker karakter (*). Kaynağın değişip değişmediğini denetlemek ve match_condition parametresi tarafından belirtilen koşula göre hareket etmek için kullanılır.

source_match_condition
MatchConditions

Etag üzerinde kullanılacak kaynak eşleştirme koşulu.

file_last_write_mode
Literal["preserve", "now"]

Dosyanın son yazma zamanının korunması veya üzerine yazılması gerekiyorsa. Olası değerler "preserve" veya "now" şeklindedir. Belirtilmezse, dosya son yazma saati geçerli tarih/saat olarak değiştirilir.

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

lease
ShareLeaseClient veya str

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

Sürüm 12.1.0'da yeni.

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.

source_authorization
str

Kaynak bloba erişmek için istemci gizli dizisini kullanarak hizmet sorumlusu olarak kimlik doğrulaması yapın. source_authorization dizesinin ön ekinin "taşıyıcı" olduğundan emin olun.

Ö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