ShareServiceClient Kelas
Klien untuk berinteraksi dengan Layanan Berbagi File di tingkat akun.
Klien ini menyediakan operasi untuk mengambil dan mengonfigurasi properti akun serta mencantumkan, membuat dan menghapus berbagi dalam akun. Untuk operasi yang berkaitan dengan berbagi tertentu, klien untuk entitas tersebut get_share_client juga dapat diambil menggunakan fungsi .
Untuk konfigurasi opsional lainnya, silakan klik di sini.
- Warisan
-
azure.storage.fileshare._shared.base_client.StorageAccountHostsMixinShareServiceClient
Konstruktor
ShareServiceClient(account_url: str, credential: str | Dict[str, str] | AzureNamedKeyCredential | AzureSasCredential | TokenCredential | None = None, *, token_intent: Literal['backup'] | None = None, **kwargs: Any)
Parameter
- account_url
- str
URL ke akun penyimpanan berbagi file. Entitas lain yang disertakan dalam jalur URL (misalnya berbagi atau file) akan dibuang. URL ini dapat diautentikasi secara opsional dengan token SAS.
- credential
Kredensial yang digunakan untuk mengautentikasi. Ini opsional jika URL akun sudah memiliki token SAS. Nilainya dapat berupa string token SAS, instans AzureSasCredential atau AzureNamedKeyCredential dari azure.core.credentials, kunci akses bersama akun, atau instans kelas TokenCredentials dari azure.identity. Jika URI sumber daya sudah berisi token SAS, ini akan diabaikan demi kredensial eksplisit
- kecuali dalam kasus AzureSasCredential, di mana token SAS yang bertentangan akan memunculkan ValueError. Jika menggunakan instans AzureNamedKeyCredential, "nama" harus menjadi nama akun penyimpanan, dan "kunci" harus menjadi kunci akun penyimpanan.
- token_intent
- Literal['backup']
Diperlukan saat menggunakan TokenCredential untuk autentikasi dan diabaikan untuk bentuk autentikasi lainnya. Menentukan niat untuk semua permintaan saat menggunakan autentikasi TokenCredential . Potensi nilai:
backup - Menentukan permintaan ditujukan untuk operasi jenis cadangan/admin, yang berarti bahwa semua ACL file/direktori dilewati dan izin penuh diberikan. Pengguna juga harus memiliki izin RBAC yang diperlukan.
- allow_trailing_dot
- bool
Jika true, titik berikutnya tidak akan dipangkas dari URI target.
- allow_source_trailing_dot
- bool
Jika true, titik berikutnya tidak akan dipangkas dari URI sumber.
- api_version
- str
Versi Storage API yang akan digunakan untuk permintaan. Nilai default adalah versi layanan terbaru yang kompatibel dengan SDK saat ini. Pengaturan ke versi yang lebih lama dapat mengakibatkan berkurangnya kompatibilitas fitur.
Baru dalam versi 12.1.0.
- secondary_hostname
- str
Nama host titik akhir sekunder.
- max_range_size
- int
Ukuran rentang maksimum yang digunakan untuk unggahan file. Default ke 4*1024*1024
.
Contoh
Buat klien layanan berbagi dengan url dan kredensial.
from azure.storage.fileshare import ShareServiceClient
share_service_client = ShareServiceClient(
account_url=self.account_url,
credential=self.access_key
)
Metode
close |
Metode ini untuk menutup soket yang dibuka oleh klien. Ini tidak perlu digunakan saat menggunakan dengan manajer konteks. |
create_share |
Membuat berbagi baru di bawah akun yang ditentukan. Jika berbagi dengan nama yang sama sudah ada, operasi akan gagal. Mengembalikan klien untuk berinteraksi dengan berbagi yang baru dibuat. |
delete_share |
Menandai berbagi yang ditentukan untuk dihapus. Berbagi kemudian dihapus selama pengumpulan sampah. |
from_connection_string |
Buat ShareServiceClient dari String Koneksi. |
get_service_properties |
Mendapatkan properti layanan Berbagi File akun penyimpanan, termasuk Azure Storage Analytics. |
get_share_client |
Dapatkan klien untuk berinteraksi dengan berbagi yang ditentukan. Berbagi belum ada. |
list_shares |
Mengembalikan paging otomatis yang dapat diulang dari ShareProperties seperti dict di bawah akun yang ditentukan. Generator akan dengan malas mengikuti token kelanjutan yang dikembalikan oleh layanan dan berhenti ketika semua berbagi telah dikembalikan. |
set_service_properties |
Mengatur properti layanan Berbagi File akun penyimpanan, termasuk Azure Storage Analytics. Jika elemen (misalnya hour_metrics) dibiarkan sebagai Tidak Ada, pengaturan yang ada pada layanan untuk fungsi tersebut dipertahankan. |
undelete_share |
Memulihkan berbagi yang dihapus sementara. Operasi hanya akan berhasil jika digunakan dalam jumlah hari yang ditentukan yang ditetapkan dalam kebijakan penyimpanan penghapusan. Baru dalam versi 12.2.0: Operasi ini diperkenalkan dalam versi API '2019-12-12'. |
close
Metode ini untuk menutup soket yang dibuka oleh klien. Ini tidak perlu digunakan saat menggunakan dengan manajer konteks.
close()
create_share
Membuat berbagi baru di bawah akun yang ditentukan. Jika berbagi dengan nama yang sama sudah ada, operasi akan gagal. Mengembalikan klien untuk berinteraksi dengan berbagi yang baru dibuat.
create_share(share_name: str, **kwargs) -> ShareClient
Parameter
Dict dengan pasangan name_value untuk dikaitkan dengan berbagi sebagai metadata. Contoh:{'Category':'test'}
- quota
- int
Kuota dalam byte.
- timeout
- int
Mengatur batas waktu sisi server untuk operasi dalam hitung detik. Untuk detail selengkapnya, lihat https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Nilai ini tidak dilacak atau divalidasi pada klien. Untuk mengonfigurasi batas waktu jaringan sisi klien, lihat di sini.
Mengembalikan
ShareClient untuk Berbagi yang baru dibuat.
Tipe hasil
Contoh
Buat berbagi di layanan berbagi file.
file_service.create_share(share_name="fileshare1")
delete_share
Menandai berbagi yang ditentukan untuk dihapus. Berbagi kemudian dihapus selama pengumpulan sampah.
delete_share(share_name: ShareProperties | str, delete_snapshots: bool | None = False, **kwargs) -> None
Parameter
- share_name
- str atau ShareProperties
Berbagi yang akan dihapus. Ini bisa menjadi nama berbagi, atau instans ShareProperties.
- timeout
- int
Mengatur batas waktu sisi server untuk operasi dalam hitung detik. Untuk detail selengkapnya, lihat https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Nilai ini tidak dilacak atau divalidasi pada klien. Untuk mengonfigurasi batas waktu jaringan sisi klien, lihat di sini.
Tipe hasil
Contoh
Menghapus berbagi di layanan berbagi file.
file_service.delete_share(share_name="fileshare1")
from_connection_string
Buat ShareServiceClient dari String Koneksi.
from_connection_string(conn_str: str, credential: str | Dict[str, str] | AzureNamedKeyCredential | AzureSasCredential | TokenCredential | None = None, **kwargs: Any) -> Self
Parameter
- credential
Kredensial yang digunakan untuk mengautentikasi. Ini opsional jika URL akun sudah memiliki token SAS. Nilainya dapat berupa string token SAS, instans AzureSasCredential atau AzureNamedKeyCredential dari azure.core.credentials, kunci akses bersama akun, atau instans kelas TokenCredentials dari azure.identity. Jika URI sumber daya sudah berisi token SAS, ini akan diabaikan demi kredensial eksplisit
- kecuali dalam kasus AzureSasCredential, di mana token SAS yang bertentangan akan memunculkan ValueError. Jika menggunakan instans AzureNamedKeyCredential, "nama" harus menjadi nama akun penyimpanan, dan "kunci" harus menjadi kunci akun penyimpanan.
Mengembalikan
Klien layanan Berbagi File.
Tipe hasil
Contoh
Buat klien layanan berbagi dengan string koneksi.
from azure.storage.fileshare import ShareServiceClient
share_service_client = ShareServiceClient.from_connection_string(self.connection_string)
get_service_properties
Mendapatkan properti layanan Berbagi File akun penyimpanan, termasuk Azure Storage Analytics.
get_service_properties(**kwargs: Any) -> Dict[str, Any]
Parameter
- timeout
- int
Mengatur batas waktu sisi server untuk operasi dalam hitung detik. Untuk detail selengkapnya, lihat https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Nilai ini tidak dilacak atau divalidasi pada klien. Untuk mengonfigurasi batas waktu jaringan sisi klien, lihat di sini.
Mengembalikan
Kamus yang berisi properti layanan file seperti pengelogan analitik, metrik jam/menit, aturan cors, dll.
Tipe hasil
Contoh
Mendapatkan properti layanan berbagi file.
properties = file_service.get_service_properties()
get_share_client
Dapatkan klien untuk berinteraksi dengan berbagi yang ditentukan. Berbagi belum ada.
get_share_client(share: ShareProperties | str, snapshot: Dict[str, Any] | str | None = None) -> ShareClient
Parameter
- share
- str atau ShareProperties
Bagiannya. Ini bisa menjadi nama berbagi, atau instans ShareProperties.
- snapshot
- str
Rekam jepret berbagi opsional untuk dioperasikan. Ini bisa menjadi string ID rekam jepret atau respons yang dikembalikan dari <xref:azure.storage.fileshare.create_snapshot>.
Mengembalikan
Sebuah ShareClient.
Tipe hasil
Contoh
Mendapatkan klien berbagi.
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
Mengembalikan paging otomatis yang dapat diulang dari ShareProperties seperti dict di bawah akun yang ditentukan. Generator akan dengan malas mengikuti token kelanjutan yang dikembalikan oleh layanan dan berhenti ketika semua berbagi telah dikembalikan.
list_shares(name_starts_with: str | None = None, include_metadata: bool | None = False, include_snapshots: bool | None = False, **kwargs) -> ItemPaged[ShareProperties]
Parameter
- name_starts_with
- str
Memfilter hasil untuk mengembalikan hanya berbagi yang namanya dimulai dengan name_starts_with yang ditentukan.
- include_snapshots
- bool
Menentukan bahwa salinan bayangan berbagi dikembalikan dalam respons.
- include_deleted
- bool
Menentukan bahwa berbagi yang dihapus dikembalikan dalam respons. Ini hanya untuk berbagi akun yang diaktifkan penghapusan sementara.
- timeout
- int
Mengatur batas waktu sisi server untuk operasi dalam detik. Untuk detail selengkapnya, lihat https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Nilai ini tidak dilacak atau divalidasi pada klien. Untuk mengonfigurasi batas waktu jaringan sisi klien, lihat di sini.
Mengembalikan
Yang dapat diulang (halaman otomatis) ShareProperties.
Tipe hasil
Contoh
Mencantumkan berbagi dalam layanan berbagi file.
# 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
Mengatur properti layanan Berbagi File akun penyimpanan, termasuk Azure Storage Analytics. Jika elemen (misalnya hour_metrics) dibiarkan sebagai Tidak Ada, pengaturan yang ada pada layanan untuk fungsi tersebut dipertahankan.
set_service_properties(hour_metrics: Metrics | None = None, minute_metrics: Metrics | None = None, cors: List[CorsRule] | None = None, protocol: ShareProtocolSettings | None = None, **kwargs) -> None
Parameter
- hour_metrics
- Metrics
Pengaturan metrik jam menyediakan ringkasan statistik permintaan yang dikelompokkan menurut API dalam agregat per jam untuk file.
- minute_metrics
- Metrics
Pengaturan metrik menit menyediakan statistik permintaan untuk setiap menit untuk file.
- cors
- list(CorsRule)
Anda dapat menyertakan hingga lima elemen CorsRule dalam daftar. Jika daftar kosong ditentukan, semua aturan CORS akan dihapus, dan CORS akan dinonaktifkan untuk layanan.
- timeout
- int
Mengatur batas waktu sisi server untuk operasi dalam detik. Untuk detail selengkapnya, lihat https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Nilai ini tidak dilacak atau divalidasi pada klien. Untuk mengonfigurasi batas waktu jaringan sisi klien, lihat di sini.
Tipe hasil
Contoh
Mengatur properti layanan berbagi file.
# 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
Memulihkan berbagi yang dihapus sementara.
Operasi hanya akan berhasil jika digunakan dalam jumlah hari yang ditentukan yang ditetapkan dalam kebijakan penyimpanan penghapusan.
Baru dalam versi 12.2.0: Operasi ini diperkenalkan dalam versi API '2019-12-12'.
undelete_share(deleted_share_name: str, deleted_share_version: str, **kwargs: Any) -> ShareClient
Parameter
- timeout
- int
Mengatur batas waktu sisi server untuk operasi dalam detik. Untuk detail selengkapnya, lihat https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Nilai ini tidak dilacak atau divalidasi pada klien. Untuk mengonfigurasi batas waktu jaringan sisi klien, lihat di sini.
Mengembalikan
ShareClient untuk Berbagi yang tidak dihapus.
Tipe hasil
Atribut
api_version
Versi Api Penyimpanan yang digunakan untuk permintaan.
location_mode
Mode lokasi yang saat ini digunakan klien.
Secara default ini akan menjadi "primer". Opsi termasuk "primer" dan "sekunder".
primary_endpoint
URL titik akhir utama lengkap.
primary_hostname
Nama host titik akhir utama.
secondary_endpoint
URL titik akhir sekunder penuh jika dikonfigurasi.
Jika tidak tersedia, ValueError akan dinaikkan. Untuk menentukan nama host sekunder secara eksplisit, gunakan argumen kata kunci secondary_hostname opsional pada instansiasi.
Pengecualian
secondary_hostname
Nama host titik akhir sekunder.
Jika tidak tersedia, ini tidak akan ada. Untuk menentukan nama host sekunder secara eksplisit, gunakan argumen kata kunci secondary_hostname opsional pada instansiasi.
url
URL titik akhir lengkap untuk entitas ini, termasuk token SAS jika digunakan.
Ini bisa berupa titik akhir utama, atau titik akhir sekunder tergantung pada saat ini location_mode. :returns: URL titik akhir lengkap ke entitas ini, termasuk token SAS jika digunakan. :rtype: str
Azure SDK for Python
Saran dan Komentar
https://aka.ms/ContentUserFeedback.
Segera hadir: Sepanjang tahun 2024 kami akan menghentikan penggunaan GitHub Issues sebagai mekanisme umpan balik untuk konten dan menggantinya dengan sistem umpan balik baru. Untuk mengetahui informasi selengkapnya, lihat:Kirim dan lihat umpan balik untuk