Hämta resursegenskaper
Den Get Share Properties
begäran returnerar egenskaper för den angivna resursen eller resursögonblicksbilden.
Även om det här API:et stöds fullt ut är det ett äldre hanterings-API. Därför rekommenderar vi att du använder filresurser – Hämta, som tillhandahålls av lagringsresursprovidern (Microsoft.Storage) i stället.
Mer information om hur du interagerar programmatiskt med FileShare
resurser med hjälp av lagringsresursprovidern finns i Åtgärder på FileShares.
Protokolltillgänglighet
Aktiverat filresursprotokoll | Tillgänglig |
---|---|
SMB | |
NFS |
Begäran
Den Get Share Properties
begäran kan skapas på följande sätt. Vi rekommenderar att du använder HTTPS.
Metod | Begärande-URI | HTTP-version |
---|---|---|
GET/HEAD |
https://myaccount.file.core.windows.net/myshare?restype=share |
HTTP/1.1 |
GET/HEAD |
https://myaccount.file.core.windows.net/myshare?restype=share&sharesnapshot=<DateTime> |
HTTP/1.1 |
Ersätt sökvägskomponenterna som visas i begärande-URI:n med dina egna enligt följande:
Sökvägskomponent | Beskrivning |
---|---|
myaccount |
Namnet på ditt lagringskonto. |
myshare |
Namnet på filresursen. |
Information om namngivningsbegränsningar för sökvägar finns i Namn och referensresurser, kataloger, filer och metadata.
URI-parametrar
Följande ytterligare parametrar kan anges i begärande-URI:n:
Parameter | Beskrivning |
---|---|
sharesnapshot |
Valfri. Version 2017-04-17 och senare. Parametern sharesnapshot är ett ogenomskinliga datum/tid-värde som när det finns anger resursögonblicksbilden för att fråga för att hämta egenskaperna. |
timeout |
Valfri. Tidsgränsparametern uttrycks i sekunder. Mer information finns i Ange tidsgränser för Azure Files-åtgärder. |
Begärandehuvuden
De obligatoriska och valfria rubrikerna beskrivs i följande tabell:
Begärandehuvud | Beskrivning |
---|---|
Authorization |
Krävs. Anger auktoriseringsschema, kontonamn och signatur. Mer information finns i Auktorisera begäranden till Azure Storage. |
Date eller x-ms-date |
Krävs. Anger UTC (Coordinated Universal Time) för begäran. Mer information finns i Auktorisera begäranden till Azure Storage. |
x-ms-version |
Krävs för alla auktoriserade begäranden. Anger vilken version av åtgärden som ska användas för den här begäran. Mer information finns i Versionshantering för Azure Storage-tjänsterna. |
x-ms-client-request-id |
Valfri. Tillhandahåller ett klientgenererat, täckande värde med en kibibytesteckengräns (KiB) som registreras i loggarna när loggningen konfigureras. Vi rekommenderar starkt att du använder det här huvudet för att korrelera aktiviteter på klientsidan med begäranden som servern tar emot. Mer information finns i Övervaka Azure Files-. |
x-ms-lease-id:<ID> |
Valfri. Version 2020-02-10 och senare. Om rubriken anges utförs åtgärden endast om filresursens lån för närvarande är aktivt och låne-ID:t som anges i begäran matchar låne-ID:t för filresursen. Om det inte finns någon matchning misslyckas åtgärden med statuskoden 412 (förhandsvillkoret misslyckades). |
Begärandetext
Ingen.
Svar
Svaret innehåller en HTTP-statuskod och en uppsättning svarshuvuden.
Statuskod
En lyckad åtgärd returnerar statuskod 200 (OK).
Mer information om statuskoder finns i Status och felkoder.
Svarshuvuden
Svaret för den här åtgärden innehåller följande rubriker. Svaret kan också innehålla ytterligare standard-HTTP-huvuden. Alla standardhuvuden överensstämmer med HTTP/1.1-protokollspecifikationen.
Svarsrubrik | Beskrivning |
---|---|
Last-Modified |
Returnerar datum och tid då resursen senast ändrades. Datumformatet följer RFC 1123. Mer information finns i Representation av Date-Time-värden i sidhuvuden. Alla åtgärder som ändrar resursen eller dess egenskaper uppdaterar den senaste ändrade tiden. Åtgärder på filer påverkar inte resursens senaste ändringstid. |
x-ms-meta-name:value |
En uppsättning namn/värde-par som innehåller användardefinierade metadata för resursen. |
ETag |
Innehåller ett värde som du kan använda för att utföra åtgärder villkorligt. Värdet omges av citattecken. |
x-ms-request-id |
Identifierar unikt den begäran som gjordes och kan användas för att felsöka begäran. Mer information finns i Felsöka API-åtgärder. |
x-ms-version |
Den Azure Files-version som användes för att köra begäran. |
Date |
Ett UTC-datum/tid-värde som genereras av tjänsten, vilket anger den tid då svaret initierades. |
x-ms-share-quota |
Version 2015-02-21 och senare. Returnerar den aktuella resurskvoten i gibibyte (GiB). |
x-ms-share-provisioned-iops |
Version 2019-07-07 och senare. Returneras endast för Premium-filresurser (filresurser i lagringskontotypen FileStorage). Returnerar antalet indata-/utdataåtgärder per sekund (IOPS) som etablerats för premiumresursen. |
x-ms-share-provisioned-ingress-mbps |
Version 2019-07-07 och senare. Returneras endast för Premium-filresurser (filresurser i lagringskontotypen FileStorage). Returnerar ingressen i mebibyte per sekund (MiB/s), som etablerats för premiumresursen. |
x-ms-share-provisioned-egress-mbps |
Version 2019-07-07 och senare. Returneras endast för Premium-filresurser (filresurser i lagringskontotypen FileStorage). Returnerar utgående i MiB/s, som etablerats för premiumresursen. |
x-ms-share-provisioned-bandwidth-mibps |
Version 2021-02-12 och senare. Returneras endast för Premium-filresurser (filresurser i lagringskontotypen FileStorage). Returnerar den kombinerade bandbredden (ingress + utgående) i MiB/s, som etablerad för premiumresursen. |
x-ms-share-next-allowed-quota-downgrade-time |
Version 2019-07-07 och senare. Returneras endast för Premium-filresurser (filresurser i lagringskontotypen FileStorage). Ett datum-/tidsvärde som anger när kvoten för premiumfilresursen tillåts minskas. Datumformatet följer RFC 1123. |
x-ms-access-tier |
Version 2019-12-12 och senare. Returnerar resursens aktuella åtkomstnivå. I GPv2-lagringskonton (generell användning version 2) är TransationOptimized standardnivån för resursen. I FilLagringslagringskontotyper är Premium standardnivån för resursen. |
x-ms-access-tier-change-time |
Version 2019-12-12 och senare. Returnerar datum och tid då åtkomstnivån på resursen senast ändrades. |
x-ms-access-tier-transition-state |
Version 2019-12-12 och senare. Om resursen genomgår en nivåövergång anger den här rubriken den nivå som den övergår från. |
x-ms-lease-duration:<fixed,infinite> |
Version 2020-02-10 och senare. Anger om lånet för en resurs har obegränsad eller fast varaktighet. |
x-ms-lease-state: <available;leased;expired;breaking;broken> |
Version 2020-02-10 och senare. När en resurs leasas anger den här rubriken lånetillståndet för resursen. |
x-ms-lease-status: <locked;unlocked> |
Version 2020-02-10 och senare. När en resurs leasas anger den här rubriken resursens lånestatus. |
x-ms-enabled-protocols: <SMB;NFS> |
Returnerar de aktuella resursaktiverade protokollen för version 2019-07-07 och senare. - SMB : Resursen kan nås av SMBv3.0, SMBv2.1 och REST.- NFS : Resursen kan nås av NFSv4.1. |
x-ms-root-squash: <NoRootSquash;RootSquash;AllSquash> |
Returnerar det aktuella beteendet för rotsquashing för version 2019-07-07 och senare. Endast NFS. - NoRootSquash : Rot squashing är av.- RootSquash : Begäranden från UID/GID 0 mappas till det anonyma UID/GID.- AllSquash : Alla användargränssnitt och GID:er mappas till den anonyma användaren.Det här huvudet returneras endast för resurser, inte för ögonblicksbilder. |
x-ms-enable-snapshot-virtual-directory-access: <true;false> |
Version 2024-08-04 och senare. Anger om den virtuella katalogen för ögonblicksbilder ska vara tillgänglig vid roten för resursmonteringspunkten när NFS är aktiverat. Det här huvudet returneras endast för resurser, inte för ögonblicksbilder. |
x-ms-client-request-id |
Kan användas för att felsöka begäranden och motsvarande svar. Värdet för det här huvudet är lika med värdet för x-ms-client-request-id -huvudet om det finns i begäran och värdet inte innehåller fler än 1 024 synliga ASCII-tecken. Om den x-ms-client-request-id rubriken inte finns i begäran visas den inte i svaret. |
x-ms-share-paid-bursting-enabled: <true;false> |
Version 2024-11-04 och senare. Returneras endast för Premium-filresurser (filresurser i lagringskontotypen FileStorage). Anger om betald bursting är aktiverat. Det här huvudet returneras endast för resurser, inte för ögonblicksbilder. |
x-ms-share-paid-bursting-max-iops |
Version 2024-11-04 och senare. Returneras endast för Premium-filresurser. Returnerar den högsta betalda IOPS som tillåts för resursen. Returneras endast om x-ms-share-paid-bursting-enabled är sant.Det här huvudet returneras endast för resurser, inte för ögonblicksbilder. |
x-ms-share-paid-bursting-max-bandwidth-mibps |
Version 2024-11-04 och senare. Returneras endast för Premium-filresurser. Returnerar den maximala betalda utsprängning av MiB/s som tillåts för resursen. Returneras endast om x-ms-share-paid-bursting-enabled är sant.Det här huvudet returneras endast för resurser, inte för ögonblicksbilder. |
Svarstext
Ingen.
Exempelsvar
Response Status:
HTTP/1.1 200 OK
Response Headers:
Transfer-Encoding: chunked
x-ms-meta-name: some_metadata
Date: <date>
ETag: "0x8CB171DBEAD6A6B"
Last-Modified: <date>
x-ms-share-quota: 1024
x-ms-access-tier: Premium
x-ms-version: 2020-02-10
x-ms-enabled-protocols: NFS
x-ms-root-squash: RootSquash
Server: Windows-Azure-File/1.0 Microsoft-HTTPAPI/2.0
Tillstånd
Endast kontoägaren kan anropa den här åtgärden.
Anmärkningar
Ingen.