Eigenschappen van delen ophalen
De Get Share Properties aanvraag retourneert eigenschappen voor de opgegeven share- of share-momentopname.
Hoewel deze API volledig wordt ondersteund, is dit een verouderde beheer-API. Daarom raden we u aan om in plaats daarvan bestandsshares te gebruiken:ophalen, die wordt geleverd door de opslagresourceprovider (Microsoft.Storage).
Zie Bewerkingen op FileSharesvoor meer informatie over programmatisch werken met FileShare resources met behulp van de opslagresourceprovider.
Beschikbaarheid van protocol
| Protocol voor bestandsshare ingeschakeld | Beschikbaar |
|---|---|
| SMB |
|
| NFS |
|
Verzoek
De Get Share Properties aanvraag kan als volgt worden samengesteld. U wordt aangeraden HTTPS te gebruiken.
| Methode | Aanvraag-URI | HTTP-versie |
|---|---|---|
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 |
Vervang de padonderdelen in de aanvraag-URI als volgt door uw eigen padonderdelen:
| Padonderdeel | Beschrijving |
|---|---|
myaccount |
De naam van uw opslagaccount. |
myshare |
De naam van uw bestandsshare. |
Zie Naam- en referentieshares, mappen, bestanden en metagegevensvoor meer informatie over naamgevingsbeperkingen voor paden.
URI-parameters
De volgende aanvullende parameters kunnen worden opgegeven in de aanvraag-URI:
| Parameter | Beschrijving |
|---|---|
sharesnapshot |
Facultatief. Versie 2017-04-17 en hoger. De parameter sharesnapshot is een ondoorzichtige datum/tijd-waarde die, indien aanwezig, de momentopname van de share specificeert die moet worden opgevraagd om de eigenschappen op te halen. |
timeout |
Facultatief. De time-outparameter wordt uitgedrukt in seconden. Zie Time-outs instellen voor Azure Files-bewerkingenvoor meer informatie. |
Aanvraagheaders
De vereiste en optionele headers worden beschreven in de volgende tabel:
| Aanvraagheader | Beschrijving |
|---|---|
Authorization |
Vereist. Hiermee geeft u het autorisatieschema, de accountnaam en de handtekening op. Zie Aanvragen autoriseren voor Azure Storagevoor meer informatie. |
Date of x-ms-date |
Vereist. Hiermee geeft u de Coordinated Universal Time (UTC) voor de aanvraag. Zie Aanvragen autoriseren voor Azure Storagevoor meer informatie. |
x-ms-version |
Vereist voor alle geautoriseerde aanvragen. Hiermee geeft u de versie van de bewerking die moet worden gebruikt voor deze aanvraag. Zie Versiebeheer voor de Azure Storage-servicesvoor meer informatie. |
x-ms-client-request-id |
Facultatief. Biedt een door de client gegenereerde, ondoorzichtige waarde met een tekenlimiet van 1 kibibyte (KiB) die wordt vastgelegd in de logboeken wanneer logboekregistratie is geconfigureerd. We raden u ten zeerste aan deze header te gebruiken om activiteiten aan de clientzijde te correleren met aanvragen die de server ontvangt. Zie Monitor Azure Filesvoor meer informatie. |
x-ms-lease-id:<ID> |
Facultatief. Versie 2020-02-10 en hoger. Als de header is opgegeven, wordt de bewerking alleen uitgevoerd als de lease van de bestandsshare momenteel actief is en de lease-id die in de aanvraag is opgegeven, overeenkomt met de lease-id van de bestandsshare. Als er geen overeenkomst is, mislukt de bewerking met statuscode 412 (voorwaarde mislukt). |
Aanvraagbody
Geen.
Antwoord
Het antwoord bevat een HTTP-statuscode en een set antwoordheaders.
Statuscode
Een geslaagde bewerking retourneert statuscode 200 (OK).
Zie Status en foutcodesvoor meer informatie over statuscodes.
Antwoordheaders
Het antwoord voor deze bewerking bevat de volgende headers. Het antwoord kan ook aanvullende standaard HTTP-headers bevatten. Alle standaardheaders voldoen aan de HTTP/1.1-protocolspecificatie.
| Antwoordheader | Beschrijving |
|---|---|
Last-Modified |
Retourneert de datum en tijd waarop de share het laatst is gewijzigd. De datumnotatie volgt RFC 1123. Zie Weergave van Date-Time waarden in koptekstenvoor meer informatie. Elke bewerking die de share of de eigenschappen ervan wijzigt, werkt de laatste wijzigingstijd bij. Bewerkingen op bestanden hebben geen invloed op de laatste wijzigingstijd van de share. |
x-ms-meta-name:value |
Een set naam-waardeparen die de door de gebruiker gedefinieerde metagegevens van de share bevatten. |
ETag |
Bevat een waarde die u kunt gebruiken om bewerkingen voorwaardelijk uit te voeren. De waarde staat tussen aanhalingstekens. |
x-ms-request-id |
Identificeer de aanvraag die is gemaakt en kan worden gebruikt om problemen met de aanvraag op te lossen. Zie Problemen met API-bewerkingen oplossenvoor meer informatie. |
x-ms-version |
De Azure Files-versie die is gebruikt om de aanvraag uit te voeren. |
Date |
Een UTC-datum/tijdwaarde die wordt gegenereerd door de service, wat de tijd aangeeft waarop het antwoord is gestart. |
x-ms-share-quota |
Versie 2015-02-21 en hoger. Retourneert het huidige quotum voor aandelen in gibibytes (GiB). |
x-ms-share-provisioned-iops |
Versie 2019-07-07 en hoger. Alleen geretourneerd voor Premium-bestandsshares (bestandsshares binnen het opslagaccounttype FileStorage). Retourneert het aantal invoer-/uitvoerbewerkingen per seconde (IOPS), zoals ingericht voor de Premium-share. |
x-ms-share-provisioned-ingress-mbps |
Versie 2019-07-07 en hoger. Alleen geretourneerd voor Premium-bestandsshares (bestandsshares binnen het opslagaccounttype FileStorage). Retourneert het inkomend verkeer in mebibytes per seconde (MiB/s), zoals ingericht voor de Premium-share. |
x-ms-share-provisioned-egress-mbps |
Versie 2019-07-07 en hoger. Alleen geretourneerd voor Premium-bestandsshares (bestandsshares binnen het opslagaccounttype FileStorage). Retourneert het uitgaand verkeer in MiB/s, zoals ingericht voor de Premium-share. |
x-ms-share-provisioned-bandwidth-mibps |
Versie 2021-02-12 en hoger. Alleen geretourneerd voor Premium-bestandsshares (bestandsshares binnen het opslagaccounttype FileStorage). Retourneert de gecombineerde bandbreedte (inkomend en uitgaand verkeer) in MiB/s, zoals ingericht voor de Premium-share. |
x-ms-share-next-allowed-quota-downgrade-time |
Versie 2019-07-07 en hoger. Alleen geretourneerd voor Premium-bestandsshares (bestandsshares binnen het opslagaccounttype FileStorage). Een datum/tijd-waarde die aangeeft wanneer het quotum voor de Premium-bestandsshare mag worden verlaagd. De datumnotatie volgt RFC 1123. |
x-ms-access-tier |
Versie 2019-12-12 en hoger. Retourneert de huidige toegangslaag van de share. In opslagaccounts voor algemeen gebruik versie 2 (GPv2) is TransationOptimized de standaardlaag van de share. In FileStorage-opslagaccounttypen is Premium de standaardlaag van de share. |
x-ms-access-tier-change-time |
Versie 2019-12-12 en hoger. Retourneert de datum en tijd waarop de toegangslaag op de share voor het laatst is gewijzigd. |
x-ms-access-tier-transition-state |
Versie 2019-12-12 en hoger. Als de share een laagovergang ondergaat, geeft deze header de laag aan van waaruit deze overgaat. |
x-ms-lease-duration:<fixed,infinite> |
Versie 2020-02-10 en hoger. Hiermee geeft u op of de lease op een share een oneindige of vaste duur heeft. |
x-ms-lease-state: <available;leased;expired;breaking;broken> |
Versie 2020-02-10 en hoger. Wanneer een share wordt geleased, geeft deze header de leasestatus van de share op. |
x-ms-lease-status: <locked;unlocked> |
Versie 2020-02-10 en hoger. Wanneer een share wordt geleased, geeft deze header de leasestatus van de share op. |
x-ms-enabled-protocols: <SMB;NFS> |
Retourneert de huidige protocollen met share-functionaliteit voor versie 2019-07-07 en hoger. - SMB: de share is toegankelijk via SMBv3.0, SMBv2.1 en REST.- NFS: de share is toegankelijk via NFSv4.1. |
x-ms-root-squash: <NoRootSquash;RootSquash;AllSquash> |
Retourneert het huidige root-pompgedrag van de share voor versie 2019-07-07 en hoger. Alleen NFS. - NoRootSquash: Root squashen is uitgeschakeld.- RootSquash: aanvragen van UID/GID 0 worden toegewezen aan de anonieme UID/GID.- AllSquash: alle UID's en GID's worden toegewezen aan de anonieme gebruiker.Deze header wordt alleen geretourneerd voor shares, niet voor momentopnamen. |
x-ms-enable-snapshot-virtual-directory-access: <true;false> |
Versie 2024-08-04 en hoger. Hiermee geeft u op of de virtuele map van de momentopname toegankelijk moet zijn in de hoofdmap van het share-koppelpunt wanneer NFS is ingeschakeld. Deze header wordt alleen geretourneerd voor shares, niet voor momentopnamen. |
x-ms-client-request-id |
Kan worden gebruikt om problemen met aanvragen en bijbehorende antwoorden op te lossen. De waarde van deze header is gelijk aan de waarde van de x-ms-client-request-id header als deze aanwezig is in de aanvraag en de waarde niet meer dan 1024 zichtbare ASCII-tekens bevat. Als de x-ms-client-request-id header niet aanwezig is in de aanvraag, is deze niet aanwezig in het antwoord. |
x-ms-share-paid-bursting-enabled: <true;false> |
Versie 2024-11-04 en hoger. Alleen geretourneerd voor Premium-bestandsshares (bestandsshares binnen het opslagaccounttype FileStorage). Hiermee geeft u op of betaalde bursting is ingeschakeld. Deze header wordt alleen geretourneerd voor shares, niet voor momentopnamen. |
x-ms-share-paid-bursting-max-iops |
Versie 2024-11-04 en hoger. Alleen geretourneerd voor Premium-bestandsshares. Hiermee wordt de maximaal betaalde bursting-IOPS geretourneerd die is toegestaan voor de share. Alleen geretourneerd als x-ms-share-paid-bursting-enabled waar is.Deze header wordt alleen geretourneerd voor shares, niet voor momentopnamen. |
x-ms-share-paid-bursting-max-bandwidth-mibps |
Versie 2024-11-04 en hoger. Alleen geretourneerd voor Premium-bestandsshares. Retourneert de maximaal betaalde bursting MiB/s die zijn toegestaan voor de share. Alleen geretourneerd als x-ms-share-paid-bursting-enabled waar is.Deze header wordt alleen geretourneerd voor shares, niet voor momentopnamen. |
Hoofdtekst van antwoord
Geen.
Voorbeeldantwoord
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
Machtiging
Alleen de accounteigenaar kan deze bewerking aanroepen.
Opmerkingen
Geen.