Mendapatkan Properti Layanan File

Artikel
07/19/2023

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

Ketersediaan protokol

Mengaktifkan protokol berbagi file	Tersedia
SMB
NFS

Minta

Permintaan Get File Service Properties dapat ditentukan sebagai berikut. Kami menyarankan agar Anda menggunakan HTTPS. Ganti <account-name> dengan nama akun penyimpanan Anda:

Metode	Meminta URI	Versi HTTP
GET	`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

Tabel berikut ini menjelaskan header permintaan yang diperlukan dan opsional.

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` atau `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 mengambil properti 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 Azure 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

Tidak ada.

Respons

Respons mencakup kode status HTTP, sekumpulan header respons, dan isi respons.

Kode status

Operasi yang berhasil mengembalikan kode status 200 (OK).

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`	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 ini 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 ada dalam respons.

Isi Respons

Format isi respons 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>

Elemen isi respons dijelaskan dalam tabel berikut:

Nama	Deskripsi
`HourMetrics`	Mengelompokkan pengaturan Storage Analytics `HourMetrics` . Pengaturan `HourMetrics` menyediakan ringkasan statistik permintaan, yang dikelompokkan menurut API dalam agregat per jam.
`MinuteMetrics`	Mengelompokkan pengaturan Storage Analytics `MinuteMetrics` . Pengaturan `MinuteMetrics` menyediakan statistik permintaan untuk setiap menit.
`Version`	Versi Storage Analytics yang saat ini sedang digunakan.
`Enabled`	Menunjukkan apakah metrik diaktifkan untuk layanan File.
`IncludeAPIs`	Menunjukkan apakah metrik menghasilkan statistik ringkasan untuk operasi API yang disebut.
`RetentionPolicy/Enabled`	Menunjukkan apakah kebijakan penyimpanan diaktifkan untuk layanan File.
`RetentionPolicy/Days`	Menunjukkan jumlah hari penyimpanan data metrik. Semua data yang lebih lama dari nilai ini dihapus berdasarkan upaya terbaik.
`Cors`	Mengelompokkan semua aturan berbagi sumber daya lintas asal (CORS).
`CorsRule`	Pengaturan grup untuk aturan CORS.
`AllowedOrigins`	Daftar domain asal yang dipisahkan koma yang diizinkan melalui CORS, atau "*" jika semua domain diizinkan.
`ExposedHeaders`	Daftar header respons yang dipisahkan koma untuk diekspos ke klien CORS.
`MaxAgeInSeconds`	Jumlah detik klien atau browser harus menyimpan respons preflight.
`AllowedHeaders`	Daftar header yang dipisahkan koma yang diizinkan untuk menjadi bagian dari permintaan lintas asal.
`AllowedMethods`	Daftar metode HTTP yang dipisahkan koma yang diizinkan untuk dijalankan oleh asal. Untuk Azure Files, metode yang diizinkan adalah DELETE, GET, HEAD, MERGE, POST, OPTIONS, dan PUT.
`ShareDeleteRetentionPolicy`	Properti penghapusan sementara untuk berbagi file Azure di akun penyimpanan ini.
`Days`	Menunjukkan jumlah hari berbagi file Azure harus dipertahankan (dihapus sementara). Nilai minimum yang ditentukan dapat adalah 1 dan nilai maksimum adalah 365.
`Enabled`	Menunjukkan apakah akun penyimpanan mengaktifkan penghapusan sementara untuk Azure Files.
`ProtocolSettings`	Mengelompokkan pengaturan untuk protokol sistem file.
`SMB`	Mengelompokkan pengaturan untuk Blok Pesan Server (SMB).
`Multichannel`	Berisi pengaturan untuk SMB Multichannel. Pengaturan ini memiliki satu properti: diaktifkan/dinonaktifkan.
`Version`	Tersedia pada versi 2020-04-08. Daftar versi SMB yang diizinkan yang dipisahkan koma. Nilai yang mungkin: `SMB2.1`, `SMB3.0`, dan `SMB3.1.1`. Jika `Version` tidak ditentukan, defaultnya adalah semua versi diaktifkan. Namun, SMB 2.1 hanya tersedia jika properti akun `require secure transit` penyimpanan dinonaktifkan, karena SMB 2.1 tidak mendukung enkripsi.
`AuthenticationMethods`	Tersedia pada versi 2020-04-08. Daftar metode autentikasi yang diizinkan yang dipisahkan koma. Nilai yang mungkin: `NTLMv2`, `Kerberos`. Jika `AuthenticationMethods` tidak ditentukan, defaultnya adalah semua metode autentikasi diizinkan.
`KerberosTicketEncryption`	Tersedia pada versi 2020-04-08. Daftar algoritma enkripsi tiket Kerberos yang dipisahkan koma yang diizinkan. Nilai yang mungkin: `RC4-HMAC` dan `AES-256`. Jika `KerberosTicketEncryption` tidak ditentukan, defaultnya adalah semua algoritma enkripsi tiket Kerberos didukung.
`ChannelEncryption`	Tersedia pada versi 2020-04-08. Daftar protokol enkripsi saluran SMB yang dipisahkan koma yang diizinkan. Nilai yang mungkin: `AES-128-CCM`, `AES-128-GCM`, dan `AES-256-GCM`. Jika `ChannelEncryption` tidak ditentukan, defaultnya adalah semua nilai enkripsi saluran didukung. Jika properti akun `require secure transit` penyimpanan dinonaktifkan, akses SMB yang tidak terenkripsi juga diizinkan.

Authorization

Hanya pemilik akun penyimpanan yang dapat memanggil operasi ini.

Sampel permintaan dan respons

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

Metode	URL	Protokol
GET	`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

Setelah permintaan dikirim, respons berikut dikembalikan:

HTTP/1.1 200 OK  
Content-Length: 1020  
Content-Type: application/xml  
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

Respons mencakup 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>

Keterangan

Untuk informasi terperinci tentang aturan CORS dan logika evaluasi, lihat dukungan CORS untuk layanan Azure Storage.

Untuk informasi lebih lanjut, lihat Storage Analytics.