Mengatur Properti Layanan File

  • Artikel

Operasi Set File Service Properties menetapkan properti untuk sumber daya layanan File dengan menggunakan FileREST API. Meskipun API ini didukung penuh, API ini adalah API manajemen warisan. Kami menyarankan agar Anda menggunakan Layanan File - Atur Properti Layanan, yang disediakan oleh penyedia sumber daya Azure Storage (Microsoft.Storage). Untuk mempelajari selengkapnya tentang berinteraksi secara terprogram dengan sumber daya layanan File dengan menggunakan penyedia sumber daya Azure Storage, lihat Operasi pada layanan File.

Ketersediaan protokol

Mengaktifkan protokol berbagi file Tersedia
SMB Ya
NFS Ya

Minta

Anda dapat menentukan Set File Service Properties permintaan sebagai berikut. Kami menyarankan agar Anda menggunakan HTTPS. Ganti nama akun dengan nama akun penyimpanan Anda:

Metode Meminta URI Versi HTTP
PUT https://account-name.file.core.windows.net/?restype=service&comp=properties HTTP/1.1

Catatan

URI harus selalu menyertakan karakter garis miring (/) untuk memisahkan nama host dari jalur dan bagian kueri URI. Dalam operasi ini, bagian jalur URI kosong.

Parameter URI

Parameter URI Deskripsi
restype=service&comp=properties Wajib diisi. Kombinasi kedua string kueri diperlukan untuk mengatur properti layanan penyimpanan.
timeout Opsional. Parameter timeout dinyatakan dalam hitung detik. Untuk informasi selengkapnya, lihat Mengatur waktu habis untuk operasi layanan File.

Header permintaan

Header permintaan yang diperlukan dan opsional dijelaskan dalam tabel berikut:

Meminta kop Deskripsi
Authorization Wajib diisi. Menentukan skema otorisasi, nama akun penyimpanan, dan tanda tangan. Untuk informasi selengkapnya, lihat Mengotorisasi permintaan ke Azure Storage.
Date or x-ms-date Wajib diisi. Menentukan Waktu Universal Terkoordinasi (UTC) untuk permintaan tersebut. Untuk informasi selengkapnya, lihat Mengotorisasi permintaan ke Azure Storage.
x-ms-version Diperlukan untuk semua permintaan yang diotorisasi. Menentukan versi operasi yang akan digunakan untuk permintaan ini. Operasi ini hanya tersedia dalam versi 2015-02-21 dan yang lebih baru. Untuk mengaktifkan metrik untuk layanan File, Anda harus menentukan versi 2015-04-05 atau yang lebih baru.

Untuk informasi selengkapnya, lihat Penerapan versi untuk layanan Azure Storage.
x-ms-client-request-id Opsional. Menyediakan nilai buram yang dihasilkan klien dengan batas karakter 1 kibibyte (KiB) yang dicatat dalam log Storage Analytics saat pengelogan dikonfigurasi. Kami sangat menyarankan Anda menggunakan header ini untuk menghubungkan aktivitas sisi klien dengan permintaan yang diterima server. Untuk informasi selengkapnya, lihat Memantau Azure Files.

Isi permintaan

Format isi permintaan untuk versi 2020-02-10 adalah sebagai berikut:

<?xml version="1.0" encoding="utf-8"?>  
<StorageServiceProperties>  
    <HourMetrics>  
        <Version>version-number</Version>  
        <Enabled>true|false</Enabled>  
        <IncludeAPIs>true|false</IncludeAPIs>  
        <RetentionPolicy>  
            <Enabled>true|false</Enabled>  
            <Days>number-of-days</Days>  
        </RetentionPolicy>  
    </HourMetrics>  
    <MinuteMetrics>  
        <Version>version-number</Version>  
        <Enabled>true|false</Enabled>  
        <IncludeAPIs>true|false</IncludeAPIs>  
        <RetentionPolicy>  
            <Enabled>true|false</Enabled>  
            <Days>number-of-days</Days>  
        </RetentionPolicy>  
    </MinuteMetrics>  
    <Cors>  
        <CorsRule>  
            <AllowedOrigins>comma-separated-list-of-allowed-origins</AllowedOrigins>  
            <AllowedMethods>comma-separated-list-of-HTTP-verb</AllowedMethods>  
            <MaxAgeInSeconds>max-caching-age-in-seconds</MaxAgeInSeconds>  
            <ExposedHeaders>comma-seperated-list-of-response-headers</ExposedHeaders>  
            <AllowedHeaders>comma-seperated-list-of-request-headers</AllowedHeaders>  
        </CorsRule>  
    </Cors>    
    <ShareDeleteRetentionPolicy>
        <Enabled>true|false</Enabled>
        <Days>integer-value</Days>
    </ShareDeleteRetentionPolicy>
    <ProtocolSettings>
        <SMB>
            <Multichannel>
                <Enabled>true|false</Enabled>
            </Multichannel>
            <Versions>comma-separated-list-of-smb-versions</Versions>
            <AuthenticationMethods>comma-separated-list-of-auth-methods</AuthenticationMethod>
            <KerberosTicketEncryption>csv-of-kerb-encryption-algorithms</KerberosTicketEncryption>
            <ChannelEncryption>csv-of-smb-encryption-algorithms</ChannelEncryption>
        </SMB>
    </ProtocolSettings>
</StorageServiceProperties>

Tidak perlu menentukan setiap elemen akar pada permintaan. Jika Anda menghilangkan elemen akar, pengaturan yang ada untuk layanan untuk fungsi tersebut dipertahankan. Namun, jika Anda menentukan elemen akar tertentu, Anda harus menentukan setiap elemen anak untuk elemen tersebut. Elemen root meliputi:

  • HourMetrics
  • MinuteMetrics
  • Cors
  • ProtocolSettings

Elemen isi permintaan dijelaskan dalam tabel berikut:

Nama Deskripsi
HourMetrics Opsional untuk versi 2015-04-05 dan yang lebih baru. Tidak berlaku untuk versi yang lebih lama. Mengelompokkan pengaturan Storage Analytics HourMetrics , yang menyediakan ringkasan statistik permintaan yang dikelompokkan menurut API dalam agregat per jam.
MinuteMetrics Opsional untuk versi 2015-04-05 dan yang lebih baru. Tidak berlaku untuk versi yang lebih lama. Mengelompokkan pengaturan Storage Analytics MinuteMetrics , yang menyediakan statistik permintaan untuk setiap menit.
Version Diperlukan jika metrik diaktifkan. Versi Storage Analytics yang akan dikonfigurasi. Gunakan 1.0 untuk nilai ini.
Enabled Wajib diisi. Menunjukkan apakah metrik diaktifkan untuk layanan File.
IncludeAPIs Diperlukan hanya jika metrik diaktifkan. Menunjukkan apakah metrik harus menghasilkan statistik ringkasan untuk operasi API yang disebut.
RetentionPolicy/Enabled Wajib diisi. Menunjukkan apakah kebijakan penyimpanan diaktifkan untuk layanan File. Jika false, data metrik disimpan, dan pengguna bertanggung jawab untuk menghapusnya.
RetentionPolicy/Days Diperlukan hanya jika kebijakan penyimpanan diaktifkan. Menunjukkan jumlah hari data metrik harus dipertahankan. Semua data yang lebih lama dari nilai ini dihapus. Minimum yang dapat Anda tentukan adalah 1, dan nilai maksimumnya adalah 365 (satu tahun). Data metrik dihapus berdasarkan upaya terbaik setelah periode retensi berakhir.
Cors Opsional. Elemen Cors ini didukung untuk versi 2015-02-21 dan yang lebih baru. Mengelompokkan semua aturan berbagi sumber daya lintas asal (CORS). Menghilangkan grup elemen ini tidak menimpa pengaturan CORS yang ada.
CorsRule Pilihan. Menentukan aturan CORS untuk layanan File. Anda dapat menyertakan hingga lima CorsRule elemen dalam permintaan. Jika tidak ada CorsRule elemen yang disertakan dalam isi permintaan, semua aturan CORS dihapus, dan CORS dinonaktifkan untuk layanan File.
AllowedOrigins Diperlukan jika CorsRule elemen ada. Daftar domain asal yang dipisahkan koma yang diizinkan melalui CORS, atau "*" untuk mengizinkan semua domain. Domain asal juga dapat menyertakan karakter kartubebas dalam subdomain untuk mengizinkan permintaan melalui CORS untuk semua subdomain domain. Terbatas pada 64 domain asal. Setiap asal yang diizinkan dapat memiliki hingga 256 karakter.
ExposedHeaders Diperlukan jika CorsRule elemen ada. Daftar header respons yang dipisahkan koma untuk diekspos ke klien CORS. Terbatas pada 64 header yang ditentukan dan dua header awalan. Setiap header dapat berisi hingga 256 karakter.
MaxAgeInSeconds Diperlukan jika CorsRule elemen ada. Jumlah detik klien/browser harus menyimpan respons preflight.
AllowedHeaders Diperlukan jika CorsRule elemen ada. Daftar header yang dipisahkan koma yang diizinkan untuk menjadi bagian dari permintaan lintas asal. Terbatas pada 64 header yang ditentukan dan 2 header awalan. Setiap header dapat berisi hingga 256 karakter.
AllowedMethods Diperlukan jika CorsRule elemen ada. Daftar metode HTTP yang dipisahkan koma yang diizinkan untuk dijalankan oleh asal. Untuk Azure Files, metode yang diizinkan adalah DELETE, , GET, HEAD, MERGEPOST, OPTIONS, dan PUT.
ShareDeleteRetentionPolicy Pilihan. Properti penghapusan sementara untuk berbagi file Azure di akun penyimpanan ini.
Days Pilihan. Menunjukkan jumlah hari berbagi file Azure harus dipertahankan (dihapus sementara). Minimum yang dapat Anda tentukan adalah 1, dan nilai maksimumnya adalah 365 (satu tahun).
Enabled Pilihan. Menunjukkan apakah akun penyimpanan mengaktifkan penghapusan sementara untuk Azure Files.
ProtocolSettings Pilihan. Mengelompokkan pengaturan untuk protokol sistem file.
SMB Pilihan. Mengelompokkan pengaturan untuk SMB.
Multichannel Pilihan. Berisi pengaturan untuk multisaluran SMB. Multisaluran SMB berisi Enabled properti Boolean, yang mengubah status multisaluran SMB.
Version Opsional pada versi 2020-04-08. Daftar versi SMB yang diizinkan yang dipisahkan koma. Nilai yang diizinkan adalah SMB2.1, SMB3.0, dan SMB3.1.1.
AuthenticationMethods Opsional pada versi 2020-04-08. Daftar metode autentikasi yang diizinkan yang dipisahkan koma. Nilai yang diperbolehkan adalah NTLMv2 dan Kerberos.
KerberosTicketEncryption Opsional pada versi 2020-04-08. Daftar algoritma enkripsi tiket Kerberos yang dipisahkan koma. Nilai yang diperbolehkan adalah RC4-HMAC dan AES-256.
ChannelEncryption Opsional pada versi 2020-04-08. Daftar protokol enkripsi saluran SMB yang diizinkan yang dipisahkan koma. Nilai yang diizinkan adalah AES-128-CCM, AES-128-GCM, dan AES-256-GCM.

Respons

Respons mencakup kode status HTTP dan sekumpulan header respons.

Kode status

Operasi yang berhasil mengembalikan kode status 202 (Diterima).

Header respons

Respons untuk operasi ini mencakup header berikut. Respons juga dapat mencakup header HTTP standar tambahan. Semua header standar sesuai dengan spesifikasi protokol HTTP/1.1.

Header respons Deskripsi
x-ms-request-id Nilai yang secara unik mengidentifikasi permintaan yang dibuat terhadap layanan.
x-ms-version Menentukan versi operasi yang digunakan untuk respons. Untuk informasi selengkapnya, lihat Penerapan versi untuk layanan Azure Storage.
x-ms-client-request-id Dapat digunakan untuk memecahkan masalah permintaan dan respons yang sesuai. Nilai header sama dengan nilai x-ms-client-request-id header jika ada dalam permintaan dan nilainya berisi tidak lebih dari 1.024 karakter ASCII yang terlihat. x-ms-client-request-id Jika header tidak ada dalam permintaan, header tidak akan ada dalam respons.

Isi Respons

Tidak ada.

Authorization

Hanya pemilik akun yang dapat memanggil operasi ini.

Keterangan

Pembatasan dan batasan berikut berlaku untuk aturan CORS di Azure Files:

  • Maksimal lima aturan dapat disimpan.

  • Ukuran maksimum semua pengaturan aturan CORS pada permintaan, tidak termasuk tag XML, tidak boleh melebihi 2 KiB.

  • Panjang header yang diizinkan, header yang diekspos, atau asal yang diizinkan tidak boleh melebihi 256 karakter.

  • Header yang diizinkan dan header yang diekspos dapat berupa salah satu dari berikut ini:

    • Header harfiah, di mana nama header yang tepat disediakan, seperti x-ms-meta-processed. Maksimal 64 header literal dapat ditentukan pada permintaan.

    • Header awalan, di mana awalan header disediakan, seperti x-ms-meta-data*. Menentukan awalan dengan cara ini memungkinkan atau mengekspos header apa pun yang dimulai dengan awalan tersebut. Maksimal dua header awalan dapat ditentukan pada permintaan.

  • Metode (atau kata kerja HTTP) yang ditentukan dalam AllowedMethods elemen harus sesuai dengan metode yang didukung oleh API layanan penyimpanan Azure. Metode yang didukung adalah DELETE, , HEADGET, MERGE, POST, OPTIONS, dan PUT.

Menentukan aturan CORS pada permintaan bersifat opsional. Jika Anda memanggil Set File Service Properties tanpa menentukan elemen CORS dalam isi permintaan, aturan CORS yang ada akan dipertahankan.

Untuk menonaktifkan CORS, panggil Set File Service Properties dengan pengaturan aturan CORS kosong (yaitu, </Cors>) dan tidak ada aturan CORS dalam. Panggilan ini menghapus aturan yang ada, dan menonaktifkan CORS untuk layanan File.

Semua elemen aturan CORS diperlukan jika CorsRule elemen ditentukan. Permintaan gagal dengan kode kesalahan 400 (Permintaan Buruk) jika ada elemen yang hilang.

Untuk informasi selengkapnya tentang aturan CORS dan logika evaluasi, lihat Dukungan berbagi sumber daya lintas asal untuk layanan Azure Storage.

Sampel permintaan dan respons

Contoh URI berikut membuat permintaan untuk mengubah properti layanan File untuk akun penyimpanan bernama myaccount:

PUT https://myaccount.file.core.windows.net/?restype=service&comp=properties HTTP/1.1

Permintaan dikirim dengan header berikut:

x-ms-version: 2020-02-10  
x-ms-date: <date>  
Authorization: SharedKey myaccount:Z1lTLDwtq5o1UYQluucdsXk6/iB7YxEu0m6VofAEkUE=  
Host: myaccount.file.core.windows.net

Permintaan dikirim dengan isi XML berikut:

<?xml version="1.0" encoding="utf-8"?>  
<StorageServiceProperties>  
    <HourMetrics>  
        <Version>1.0</Version>  
        <Enabled>true</Enabled>  
        <IncludeAPIs>false</IncludeAPIs>  
        <RetentionPolicy>  
            <Enabled>true</Enabled>  
            <Days>7</Days>  
        </RetentionPolicy>  
    </HourMetrics>  
    <MinuteMetrics>  
        <Version>1.0</Version>  
        <Enabled>true</Enabled>  
        <IncludeAPIs>true</IncludeAPIs>  
        <RetentionPolicy>  
            <Enabled>true</Enabled>  
            <Days>7</Days>  
        </RetentionPolicy>  
    </MinuteMetrics>  
    <Cors>  
        <CorsRule>  
            <AllowedOrigins>http://www.fabrikam.com,http://www.contoso.com</AllowedOrigins>  
            <AllowedMethods>GET,PUT</AllowedMethods>  
            <MaxAgeInSeconds>500</MaxAgeInSeconds>  
            <ExposedHeaders>x-ms-meta-data*,x-ms-meta-customheader</ExposedHeaders>  
            <AllowedHeaders>x-ms-meta-target*,x-ms-meta-customheader</AllowedHeaders>  
        </CorsRule>  
    </Cors>
    <ShareDeleteRetentionPolicy>
        <Enabled>true</Enabled>
        <Days>7</Days>
    </ShareDeleteRetentionPolicy>
    <ProtocolSettings>
        <SMB>
            <Multichannel>
                <Enabled>true</Enabled>
            </Multichannel>
            <Versions>SMB3.1.1</Versions>
            <AuthenticationMethods>Kerberos</AuthenticationMethods>
            <KerberosTicketEncryption>AES-256</KerberosTicketEncryption>
            <ChannelEncryption>AES-256-GCM</ChannelEncryption>
        </SMB>
    </ProtocolSettings>
</StorageServiceProperties>

Setelah permintaan dikirim, respons berikut dikembalikan:

HTTP/1.1 202 Accepted  
Connection: Keep-Alive  
Transfer-Encoding: chunked  
Date: <date>  
Server: Windows-Azure-File/1.0 Microsoft-HTTPAPI/2.0  
x-ms-request-id: cb939a31-0cc6-49bb-9fe5-3327691f2a30  
x-ms-version: 2015-04-05

Lihat juga

Untuk informasi selengkapnya tentang aturan CORS dan logika evaluasi, lihat Dukungan berbagi sumber daya lintas asal untuk layanan Azure Storage.

Untuk informasi selengkapnya tentang Storage Analytics, lihat Storage Analytics.