ShareServiceClient Sınıf

  • Başvuru

Dosya Paylaşımı Hizmeti ile hesap düzeyinde etkileşime geçmek için bir istemci.

Bu istemci hesap özelliklerini alıp yapılandırmanın yanı sıra hesap içindeki paylaşımları listeleme, oluşturma ve silme işlemlerini sağlar. Belirli bir paylaşımla ilgili işlemler için bu varlık için bir istemci de işlevi kullanılarak get_share_client 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
ShareServiceClient

Oluşturucu

ShareServiceClient(account_url: str, credential: str | Dict[str, str] | AzureNamedKeyCredential | AzureSasCredential | TokenCredential | None = None, *, token_intent: Literal['backup'] | None = None, **kwargs: Any)

Parametreler

account_url
str
Gerekli

Dosya paylaşımı depolama hesabının URL'si. URL yoluna dahil edilen diğer varlıklar (örneğin, paylaşım veya dosya) atılır. Bu URL isteğe bağlı olarak bir SAS belirteci ile doğrulanabilir.

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.

Örnekler

Url ve kimlik bilgileriyle paylaşım hizmeti istemcisini oluşturun.


   from azure.storage.fileshare import ShareServiceClient
   share_service_client = ShareServiceClient(
       account_url=self.account_url,
       credential=self.access_key
   )

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.
create_share

Belirtilen hesap altında yeni bir paylaşım oluşturur. Aynı ada sahip paylaşım zaten varsa işlem başarısız olur. Yeni oluşturulan paylaşımla etkileşime geçmek için bir istemci döndürür.
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 ShareServiceClient oluşturun.
get_service_properties

Azure Depolama Analizi dahil olmak üzere depolama hesabının Dosya Paylaşımı hizmetinin özelliklerini alır.
get_share_client

Belirtilen paylaşımla etkileşime geçmek için bir istemci alın. Paylaşımın zaten mevcut olması gerekmiyor.
list_shares

Belirtilen hesap altında dikte benzeri ShareProperties için otomatik disk belleği yinelenebilir değerini döndürür. Oluşturucu, hizmet tarafından döndürülen devamlılık belirteçlerini yavaş yavaş izler ve tüm paylaşımlar döndürdüğünde durur.
set_service_properties

Azure Depolama Analizi dahil olmak üzere depolama hesabının Dosya Paylaşımı hizmetinin özelliklerini ayarlar. Bir öğe (örneğin, hour_metrics) Yok olarak bırakılırsa, bu işlev için hizmette var olan ayarlar korunur.
undelete_share

Geçici olarak silinen paylaşımı geri yükler.

İşlem yalnızca silme bekletme ilkesinde ayarlanan belirtilen gün sayısı içinde kullanıldığında başarılı olur.

Sürüm 12.2.0'da yeni eklendi: Bu işlem '2019-12-12' API sürümünde kullanıma sunulmuştur.

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_share

Belirtilen hesap altında yeni bir paylaşım oluşturur. Aynı ada sahip paylaşım zaten varsa işlem başarısız olur. Yeni oluşturulan paylaşımla etkileşime geçmek için bir istemci döndürür.

create_share(share_name: str, **kwargs) -> ShareClient

Parametreler

share_name
str
Gerekli

Oluşturulacak paylaşımın adı.

metadata
dict(str,str)

Paylaşımı meta veri olarak ilişkilendirmek için name_value çiftleri olan bir dikte. Örnek:{'Category':'test'}

quota
int

Bayt cinsinden kota.

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

Yeni oluşturulan Paylaşım için bir ShareClient.

Dönüş türü

ShareClient

Örnekler

Dosya paylaşımı hizmetinde bir paylaşım oluşturun.


   file_service.create_share(share_name="fileshare1")

delete_share

Belirtilen paylaşımı silinmek üzere işaretler. Paylaşım daha sonra çöp toplama sırasında silinir.

delete_share(share_name: ShareProperties | str, delete_snapshots: bool | None = False, **kwargs) -> None

Parametreler

share_name
str veya ShareProperties
Gerekli

Silinecek paylaşım. Bu, paylaşımın adı veya ShareProperties örneği olabilir.

delete_snapshots
bool
Gerekli

Anlık görüntülerin silinip silinmediğini gösterir.

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ü

None

Örnekler

Dosya paylaşımı hizmetindeki bir paylaşımı silin.


   file_service.delete_share(share_name="fileshare1")

from_connection_string

Bağlantı Dizesinden ShareServiceClient oluşturun.

from_connection_string(conn_str: 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.

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.

Döndürülenler

Dosya Paylaşımı hizmet istemcisi.

Dönüş türü

ShareServiceClient

Örnekler

Bağlantı dizesiyle paylaşım hizmeti istemcisini oluşturun.


   from azure.storage.fileshare import ShareServiceClient
   share_service_client = ShareServiceClient.from_connection_string(self.connection_string)

get_service_properties

Azure Depolama Analizi dahil olmak üzere depolama hesabının Dosya Paylaşımı hizmetinin özelliklerini alır.

get_service_properties(**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.

Döndürülenler

Analiz günlüğü, saat/dakika ölçümleri, cors kuralları vb. gibi dosya hizmeti özelliklerini içeren bir sözlük.

Dönüş türü

Dict[str, Any]

Örnekler

Dosya paylaşımı hizmeti özelliklerini alın.


   properties = file_service.get_service_properties()

get_share_client

Belirtilen paylaşımla etkileşime geçmek için bir istemci alın. Paylaşımın zaten mevcut olması gerekmiyor.

get_share_client(share: ShareProperties | str, snapshot: Dict[str, Any] | str | None = None) -> ShareClient

Parametreler

share
str veya ShareProperties
Gerekli

Paylaşım. Bu, paylaşımın adı veya ShareProperties örneği olabilir.

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 <xref:azure.storage.fileshare.create_snapshot>döndürülen yanıt olabilir.

Döndürülenler

Bir ShareClient.

Dönüş türü

ShareClient

Örnekler

Paylaşım istemcisini alır.


   from azure.storage.fileshare import ShareServiceClient
   file_service = ShareServiceClient.from_connection_string(self.connection_string)

   # Get a share client to interact with a specific share
   share = file_service.get_share_client("fileshare2")

list_shares

Belirtilen hesap altında dikte benzeri ShareProperties için otomatik disk belleği yinelenebilir değerini döndürür. Oluşturucu, hizmet tarafından döndürülen devamlılık belirteçlerini yavaş yavaş izler ve tüm paylaşımlar döndürdüğünde durur.

list_shares(name_starts_with: str | None = None, include_metadata: bool | None = False, include_snapshots: bool | None = False, **kwargs) -> ItemPaged[ShareProperties]

Parametreler

name_starts_with
str
Gerekli

Sonuçları yalnızca adları belirtilen name_starts_with başlayan paylaşımları döndürecek şekilde filtreler.

include_metadata
bool
Gerekli

Yanıtta paylaşım meta verilerinin döndürüldüğünü belirtir.

include_snapshots
bool
Gerekli

Yanıtta paylaşım anlık görüntüsünün döndürüldüğünü belirtir.

include_deleted
bool

Yanıtta silinen paylaşımların döndürüldüğünü belirtir. Bu yalnızca paylaşım geçici silme özelliği etkin hesap içindir.

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

ShareProperties'in yinelenebilir (otomatik sayfalama).

Dönüş türü

ItemPaged[ShareProperties]

Örnekler

Dosya paylaşım hizmetindeki paylaşımları listeleyin.


   # List the shares in the file service
   my_shares = list(file_service.list_shares())

   # Print the shares
   for share in my_shares:
       print(share)

set_service_properties

Azure Depolama Analizi dahil olmak üzere depolama hesabının Dosya Paylaşımı hizmetinin özelliklerini ayarlar. Bir öğe (örneğin, hour_metrics) Yok olarak bırakılırsa, bu işlev için hizmette var olan ayarlar korunur.

set_service_properties(hour_metrics: Metrics | None = None, minute_metrics: Metrics | None = None, cors: List[CorsRule] | None = None, protocol: ShareProtocolSettings | None = None, **kwargs) -> None

Parametreler

hour_metrics
Metrics
Gerekli

Saatlik ölçüm ayarları, dosyalar için saatlik toplamalar halinde API'ye göre gruplandırılmış istek istatistiklerinin özetini sağlar.

minute_metrics
Metrics
Gerekli

Dakika ölçüm ayarları, dosyalar için her dakika için istek istatistikleri sağlar.

cors
list(CorsRule)
Gerekli

Listeye en fazla beş CorsRule öğesi ekleyebilirsiniz. Boş bir liste belirtilirse tüm CORS kuralları silinir ve hizmet için CORS devre dışı bırakılır.

protocol
ShareProtocolSettings
Gerekli

Protokol ayarlarını ayarlar

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

Dosya paylaşımı hizmet özelliklerini ayarlar.


   # Create service properties
   from azure.storage.fileshare import Metrics, CorsRule, RetentionPolicy

   # Create metrics for requests statistics
   hour_metrics = Metrics(enabled=True, include_apis=True, retention_policy=RetentionPolicy(enabled=True, days=5))
   minute_metrics = Metrics(enabled=True, include_apis=True,
                            retention_policy=RetentionPolicy(enabled=True, days=5))

   # Create CORS rules
   cors_rule1 = CorsRule(['www.xyz.com'], ['GET'])
   allowed_origins = ['www.xyz.com', "www.ab.com", "www.bc.com"]
   allowed_methods = ['GET', 'PUT']
   max_age_in_seconds = 500
   exposed_headers = ["x-ms-meta-data*", "x-ms-meta-source*", "x-ms-meta-abc", "x-ms-meta-bcd"]
   allowed_headers = ["x-ms-meta-data*", "x-ms-meta-target*", "x-ms-meta-xyz", "x-ms-meta-foo"]
   cors_rule2 = CorsRule(
       allowed_origins,
       allowed_methods,
       max_age_in_seconds=max_age_in_seconds,
       exposed_headers=exposed_headers,
       allowed_headers=allowed_headers)

   cors = [cors_rule1, cors_rule2]

   # Set the service properties
   file_service.set_service_properties(hour_metrics, minute_metrics, cors)

undelete_share

Geçici olarak silinen paylaşımı geri yükler.

İşlem yalnızca silme bekletme ilkesinde ayarlanan belirtilen gün sayısı içinde kullanıldığında başarılı olur.

Sürüm 12.2.0'da yeni eklendi: Bu işlem '2019-12-12' API sürümünde kullanıma sunulmuştur.

undelete_share(deleted_share_name: str, deleted_share_version: str, **kwargs: Any) -> ShareClient

Parametreler

deleted_share_name
str
Gerekli

Geri yükleneceği silinen paylaşımın adını belirtir.

deleted_share_version
str
Gerekli

Geri yükleneceği silinen paylaşımın sürümünü belirtir.

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

Silinmemiş Paylaşım için bir ShareClient.

Dönüş türü

ShareClient

Ö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