Ustawianie właściwości usługi plików
Operacja Set File Service Properties
ustawia właściwości zasobu usługi plików przy użyciu interfejsu API FileREST. Mimo że ten interfejs API jest w pełni obsługiwany, jest to starszy interfejs API zarządzania. Zalecamy zamiast tego użycie usług plików — ustaw właściwości usługi, które są udostępniane przez dostawcę zasobów usługi Azure Storage (Microsoft.Storage). Aby dowiedzieć się więcej o programowej interakcji z zasobem usługi Plików przy użyciu dostawcy zasobów usługi Azure Storage, zobacz Operacje w usłudze Plików.
Dostępność protokołu
Włączony protokół udziału plików | Dostępne |
---|---|
SMB | |
NFS |
Żądanie
Żądanie można określić Set File Service Properties
w następujący sposób. Zalecamy używanie protokołu HTTPS. Zastąp nazwę konta nazwą konta magazynu:
Metoda | Identyfikator URI żądania | Wersja PROTOKOŁU HTTP |
---|---|---|
PUT | https://account-name.file.core.windows.net/?restype=service&comp=properties |
HTTP/1.1 |
Uwaga
Identyfikator URI musi zawsze zawierać znak ukośnika (/), aby oddzielić nazwę hosta od ścieżki i fragmentów zapytania identyfikatora URI. W tej operacji część ścieżki identyfikatora URI jest pusta.
Parametry identyfikatora URI
Parametr identyfikatora URI | Opis |
---|---|
restype=service&comp=properties |
Wymagane. Kombinacja obu ciągów zapytania jest wymagana do ustawienia właściwości usługi magazynu. |
timeout |
Opcjonalny. Parametr jest wyrażony timeout w sekundach. Aby uzyskać więcej informacji, zobacz Ustawianie limitów czasu dla operacji usługi plików. |
Nagłówki żądań
Wymagane i opcjonalne nagłówki żądań opisano w poniższej tabeli:
Nagłówek żądania | Opis |
---|---|
Authorization |
Wymagane. Określa schemat autoryzacji, nazwę konta magazynu i podpis. Aby uzyskać więcej informacji, zobacz Autoryzowanie żądań do usługi Azure Storage. |
Date or x-ms-date |
Wymagane. Określa dla żądania godzinę w formacie uniwersalnego czasu koordynowanego (UTC). Aby uzyskać więcej informacji, zobacz Autoryzowanie żądań do usługi Azure Storage. |
x-ms-version |
Wymagane dla wszystkich autoryzowanych żądań. Określa wersję operacji do użycia dla tego żądania. Ta operacja jest dostępna tylko w wersji 2015-02-21 lub nowszej. Aby włączyć metryki dla usługi plików, należy określić wersję 2015-04-05 lub nowszą. Aby uzyskać więcej informacji, zobacz Przechowywanie wersji usług Azure Storage. |
x-ms-client-request-id |
Opcjonalny. Udostępnia nieprzezroczystą wartość wygenerowaną przez klienta z limitem znaków 1-kibibyte (KiB), który jest rejestrowany w dziennikach analityka magazynu podczas konfigurowania rejestrowania. Zdecydowanie zalecamy używanie tego nagłówka do korelowania działań po stronie klienta z żądaniami odbieranymi przez serwer. Aby uzyskać więcej informacji, zobacz Monitorowanie Azure Files. |
Treść żądania
Format treści żądania dla wersji 2020-02-10 jest następujący:
<?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>
Nie trzeba określać każdego elementu głównego w żądaniu. Jeśli pominięto element główny, istniejące ustawienia usługi dla tej funkcji zostaną zachowane. Jeśli jednak określisz określony element główny, musisz określić każdy element podrzędny dla tego elementu. Elementy główne obejmują:
HourMetrics
MinuteMetrics
Cors
ProtocolSettings
Elementy treści żądania opisano w poniższej tabeli:
Nazwa | Opis |
---|---|
HourMetrics |
Opcjonalnie dla wersji 2015-04-05 lub nowszej. Nie dotyczy wcześniejszych wersji. Grupuje ustawienia analityka magazynuHourMetrics , które zawierają podsumowanie statystyk żądań pogrupowanych według interfejsu API w agregacjach godzinowych. |
MinuteMetrics |
Opcjonalnie dla wersji 2015-04-05 lub nowszej. Nie dotyczy wcześniejszych wersji. Grupuje ustawienia analityka magazynuMinuteMetrics , które zapewniają statystyki żądań dla każdej minuty. |
Version |
Wymagane, jeśli metryki są włączone. Wersja analityka magazynu do skonfigurowania. Użyj 1.0 dla tej wartości. |
Enabled |
Wymagane. Wskazuje, czy metryki są włączone dla usługi plików. |
IncludeAPIs |
Wymagane tylko wtedy, gdy metryki są włączone. Wskazuje, czy metryki powinny generować statystyki podsumowania dla wywoływanych operacji interfejsu API. |
RetentionPolicy/Enabled |
Wymagane. Wskazuje, czy dla usługi plików włączono zasady przechowywania. Jeśli wartość false, dane metryk są zachowywane, a użytkownik jest odpowiedzialny za jego usunięcie. |
RetentionPolicy/Days |
Wymagane tylko w przypadku włączenia zasad przechowywania. Wskazuje liczbę dni przechowywania danych metryk. Wszystkie dane starsze niż ta wartość są usuwane. Minimalna wartość, którą można określić, to , a maksymalna wartość to 1 365 (rok). Dane metryk są usuwane w sposób najlepszy po wygaśnięciu okresu przechowywania. |
Cors |
Opcjonalny. Element Cors jest obsługiwany w wersji 2015-02-21 lub nowszej. Grupuje wszystkie reguły współużytkowania zasobów między źródłami (CORS). Pominięcie tej grupy elementów nie zastępuje istniejących ustawień mechanizmu CORS. |
CorsRule |
Opcjonalny. Określa regułę MECHANIZMU CORS dla usługi plików. W żądaniu można uwzględnić maksymalnie pięć elementów CorsRule . Jeśli żadne elementy nie CorsRule są uwzględnione w treści żądania, wszystkie reguły CORS zostaną usunięte, a mechanizm CORS zostanie wyłączony dla usługi plików. |
AllowedOrigins |
Wymagane, jeśli CorsRule element jest obecny. Rozdzielona przecinkami lista domen pochodzenia, które są dozwolone za pośrednictwem mechanizmu CORS lub "*", aby zezwolić na wszystkie domeny. Domena źródła może również zawierać symbol wieloznaczny w poddomenie, aby zezwolić na żądania za pośrednictwem mechanizmu CORS dla wszystkich domen podrzędnych domeny. Ograniczone do 64 domen pochodzenia. Każde dozwolone źródło może mieć maksymalnie 256 znaków. |
ExposedHeaders |
Wymagane, jeśli CorsRule element jest obecny. Rozdzielona przecinkami lista nagłówków odpowiedzi uwidacznianych klientom CORS. Ograniczone do 64 zdefiniowanych nagłówków i dwóch prefiksów nagłówków. Każdy nagłówek może zawierać maksymalnie 256 znaków. |
MaxAgeInSeconds |
Wymagane, jeśli CorsRule element jest obecny. Liczba sekund, w których klient/przeglądarka powinna buforować odpowiedź wstępną. |
AllowedHeaders |
Wymagane, jeśli CorsRule element istnieje. Rozdzielona przecinkami lista nagłówków, które mogą być częścią żądania między źródłami. Ograniczone do 64 zdefiniowanych nagłówków i 2 prefiksów nagłówków. Każdy nagłówek może zawierać maksymalnie 256 znaków. |
AllowedMethods |
Wymagane, jeśli CorsRule element istnieje. Rozdzielona przecinkami lista metod HTTP, które mogą być wykonywane przez źródło. W przypadku Azure Files dozwolone metody to DELETE , GET , HEAD , MERGE , POST , OPTIONS i PUT . |
ShareDeleteRetentionPolicy |
Opcjonalny. Właściwości usuwania nietrwałego udziałów plików platformy Azure na tym koncie magazynu. |
Days |
Opcjonalny. Wskazuje liczbę dni, w których udział plików platformy Azure powinien zostać zachowany (usunięty nietrwale). Minimalna wartość, którą można określić, to , a maksymalna wartość to 1 365 (rok). |
Enabled |
Opcjonalny. Wskazuje, czy konto magazynu ma włączone usuwanie nietrwałe dla Azure Files. |
ProtocolSettings |
Opcjonalny. Grupuje ustawienia protokołów systemu plików. |
SMB |
Opcjonalny. Grupuje ustawienia protokołu SMB. |
Multichannel |
Opcjonalny. Zawiera ustawienia wielokanałowego protokołu SMB. Funkcja SMB multichannel zawiera Enabled właściwość logiczną, która przełącza stan wielokanałowego protokołu SMB. |
Version |
Opcjonalnie w wersji 2020-04-08. Rozdzielona przecinkami lista dozwolonych wersji protokołu SMB. Dozwolone wartości to SMB2.1 , SMB3.0 i SMB3.1.1 . |
AuthenticationMethods |
Opcjonalnie w wersji 2020-04-08. Rozdzielona przecinkami lista dozwolonych metod uwierzytelniania. Dozwolone wartości to NTLMv2 i Kerberos . |
KerberosTicketEncryption |
Opcjonalnie w wersji 2020-04-08. Rozdzielana przecinkami lista dozwolonych algorytmów szyfrowania biletów Kerberos. Dozwolone wartości to RC4-HMAC i AES-256 . |
ChannelEncryption |
Opcjonalnie w wersji 2020-04-08. Rozdzielona przecinkami lista dozwolonych protokołów szyfrowania kanału SMB. Dozwolone wartości to AES-128-CCM , AES-128-GCM i AES-256-GCM . |
Reakcja
Odpowiedź zawiera kod stanu HTTP i zestaw nagłówków odpowiedzi.
Kod stanu
Operacja zakończona powodzeniem zwraca kod stanu 202 (Zaakceptowano).
Nagłówki odpowiedzi
Odpowiedź na tę operację zawiera następujące nagłówki. Odpowiedź może również zawierać dodatkowe standardowe nagłówki HTTP. Wszystkie nagłówki standardowe są zgodne ze specyfikacją protokołu HTTP/1.1.
Nagłówek odpowiedzi | Opis |
---|---|
x-ms-request-id |
Wartość, która jednoznacznie identyfikuje żądanie wykonane względem usługi. |
x-ms-version |
Określa wersję operacji, która została użyta dla odpowiedzi. Aby uzyskać więcej informacji, zobacz Przechowywanie wersji usług Azure Storage. |
x-ms-client-request-id |
Może służyć do rozwiązywania problemów z żądaniami i odpowiadającymi im odpowiedziami. Wartość nagłówka jest równa wartości x-ms-client-request-id nagłówka, jeśli znajduje się w żądaniu, a wartość nie zawiera więcej niż 1024 widocznych znaków ASCII.
x-ms-client-request-id Jeśli nagłówek nie jest obecny w żądaniu, nie będzie on obecny w odpowiedzi. |
Treść odpowiedzi
Brak.
Autoryzacja
Tylko właściciel konta może wywołać tę operację.
Uwagi
Następujące ograniczenia i ograniczenia dotyczą reguł CORS w Azure Files:
Można przechowywać maksymalnie pięć reguł.
Maksymalny rozmiar wszystkich ustawień reguł CORS dla żądania, z wyłączeniem tagów XML, nie powinien przekraczać 2 KiB.
Długość dozwolonego nagłówka, uwidocznionego nagłówka lub dozwolonego źródła nie powinna przekraczać 256 znaków.
Dozwolone nagłówki i uwidocznione nagłówki mogą być następujące:
Nagłówki literału, w których podano dokładną nazwę nagłówka, na przykład
x-ms-meta-processed
. W żądaniu można określić maksymalnie 64 nagłówki literału.Prefiksy nagłówków, w których znajduje się prefiks nagłówka, taki jak
x-ms-meta-data*
. Określenie prefiksu w ten sposób umożliwia lub uwidacznia dowolny nagłówek rozpoczynający się od tego prefiksu. W żądaniu można określić maksymalnie dwa prefiksy nagłówków.
Metody (lub czasowniki HTTP) określone w
AllowedMethods
elemecie muszą być zgodne z metodami obsługiwanymi przez interfejsy API usługi Azure Storage. Obsługiwane metody toDELETE
, ,HEAD
GET
POST
MERGE
,OPTIONS
i .PUT
Określanie reguł CORS dla żądania jest opcjonalne. Jeśli wywołasz wywołanie Set File Service Properties
bez określenia elementu CORS w treści żądania, wszystkie istniejące reguły MECHANIZMU CORS zostaną zachowane.
Aby wyłączyć mechanizm CORS, wywołaj Set File Service Properties
pustą regułę CORS (czyli </Cors>
) i nie ma wewnętrznych reguł CORS. To wywołanie usuwa wszystkie istniejące reguły i wyłącza mechanizm CORS dla usługi plików.
Wszystkie elementy reguły CORS są wymagane, jeśli CorsRule
określono element. Żądanie kończy się niepowodzeniem z kodem błędu 400 (nieprawidłowe żądanie), jeśli brakuje jakiegokolwiek elementu.
Aby uzyskać więcej informacji na temat reguł CORS i logiki oceny, zobacz Obsługa udostępniania zasobów między źródłami dla usług Azure Storage.
Przykładowe żądanie i odpowiedź
Następujący przykładowy identyfikator URI wysyła żądanie zmiany właściwości usługi plików dla konta magazynu o nazwie myaccount:
PUT https://myaccount.file.core.windows.net/?restype=service&comp=properties HTTP/1.1
Żądanie jest wysyłane z następującymi nagłówkami:
x-ms-version: 2020-02-10
x-ms-date: <date>
Authorization: SharedKey myaccount:Z1lTLDwtq5o1UYQluucdsXk6/iB7YxEu0m6VofAEkUE=
Host: myaccount.file.core.windows.net
Żądanie jest wysyłane z następującą treścią XML:
<?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>
Po wysłaniu żądania zostanie zwrócona następująca odpowiedź:
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
Zobacz też
Aby uzyskać więcej informacji na temat reguł CORS i logiki oceny, zobacz Obsługa udostępniania zasobów między źródłami dla usług Azure Storage.
Aby uzyskać więcej informacji na temat analityka magazynu, zobacz analityka magazynu.