Path - Update
Lägg till data | Rensa data | Ange egenskaper | Ange åtkomstkontroll
Laddar upp data som ska läggas till i en fil, rensar (skriver) tidigare uppladdade data till en fil, anger egenskaper för en fil eller katalog eller anger åtkomstkontroll för en fil eller katalog. Data kan bara läggas till i en fil. Samtidiga skrivningar till samma fil med flera klienter stöds inte. Den här åtgärden stöder villkorsstyrda HTTP-begäranden. Mer information finns i Ange villkorsstyrda rubriker för Blob Service-åtgärder.
PATCH https://{accountName}.{dnsSuffix}/{filesystem}/{path}?action={action}
PATCH https://{accountName}.{dnsSuffix}/{filesystem}/{path}?action={action}&position={position}&retainUncommittedData={retainUncommittedData}&close={close}&mode={mode}&maxRecords={maxRecords}&forceFlag={forceFlag}&continuation={continuation}&flush={flush}&timeout={timeout}
URI-parametrar
Name | I | Obligatorisk | Typ | Description |
---|---|---|---|---|
account
|
path | True |
string |
Namnet på Azure Storage-kontot. |
dns
|
path | True |
string |
DNS-suffixet för Azure Data Lake Storage-slutpunkten. |
filesystem
|
path | True |
string minLength: 3maxLength: 63 pattern: ^[$a-z0-9](?!.*--)[-a-z0-9]{1,61}[a-z0-9]$ |
Filsystemidentifieraren. |
path
|
path | True |
string |
Fil- eller katalogsökvägen. |
action
|
query | True |
Åtgärden måste vara "tillägg" för att ladda upp data som ska läggas till i en fil, "rensa" för att rensa tidigare uppladdade data till en fil, "setProperties" för att ange egenskaperna för en fil eller katalog, eller "setAccessControl" för att ange ägare, grupp, behörigheter eller åtkomstkontrolllista för en fil eller katalog, eller "setAccessControlRecursive" för att ange åtkomstkontrollistan för en katalog rekursivt. Observera att hierarkiskt namnområde måste vara aktiverat för kontot för att kunna använda åtkomstkontroll. Observera också att åtkomstkontrollistan (ACL) innehåller behörigheter för ägaren, ägande gruppen och andra, så att x-ms-permissions- och x-ms-acl-begäranderubrikerna är ömsesidigt uteslutande. |
|
close
|
query |
boolean |
Med Azure Storage-händelser kan program ta emot meddelanden när filer ändras. När Azure Storage-händelser aktiveras genereras en filändringshändelse. Den här händelsen har en egenskap som anger om det här är den sista ändringen för att skilja skillnaden mellan en mellanliggande tömning till en filström och den sista stängningen av en filström. Parametern close query är endast giltig när åtgärden är "flush" och ändringsmeddelanden aktiveras. Om värdet för close är "true" och tömningsåtgärden har slutförts, genererar tjänsten ett filändringsmeddelande med en egenskap som anger att det här är den slutliga uppdateringen (filströmmen har stängts). Om "false" genereras ett ändringsmeddelande som anger att filen har ändrats. Standardvärdet är falskt. Den här frågeparametern är inställd på true av Hadoop ABFS-drivrutinen för att indikera att filströmmen har stängts." |
|
continuation
|
query |
string |
Valfritt och giltigt endast för åtgärden "setAccessControlRecursive". Antalet sökvägar som bearbetas med varje anrop är begränsat. Om antalet sökvägar som ska bearbetas överskrider den här gränsen returneras en fortsättningstoken i svarshuvudet x-ms-continuation. När en fortsättningstoken returneras i svaret måste den vara procentkodad och anges i en efterföljande anrop av setAccessControlRecursive-åtgärden. |
|
flush
|
query |
boolean |
Endast giltigt för tilläggsanrop. Med den här parametern kan anroparen tömmas under ett tilläggsanrop. Standardvärdet är "false" , om "sant" rensas data med tilläggsanropet. Observera att när du använder flush=true stöds inte följande rubriker – "x-ms-cache-control", "x-ms-content-encoding", "x-ms-content-type", "x-ms-content-language", "x-ms-content-md5", "x-ms-content-disposition". Om du vill ange dessa rubriker under tömning använder du action=flush |
|
force
|
query |
boolean |
Valfritt och giltigt endast för åtgärden "setAccessControlRecursive". Om det här är "false" avslutas åtgärden snabbt när användarfel (4XX) uppstår. Om "sant" kommer api:et att ignorera användarfel och fortsätta med åtgärden på andra underentiteter i katalogen. Detaljerad status för användarfel returneras i svaret för något av scenariona. Fortsättningstoken returneras endast när forceFlag är "sant" vid användarfel. Standardvärdet för forceFlag är falskt. |
|
max
|
query |
integer (int32) minimum: 1 |
Valfritt och giltigt endast för åtgärden "setAccessControlRecursive". Den anger det maximala antalet filer eller kataloger som acl-ändringen ska tillämpas på. Om begäran utelämnas eller är större än 2 000 bearbetas upp till 2 000 objekt |
|
mode
|
query |
string |
Valfritt. Giltig och krävs för åtgärden "setAccessControlRecursive". Läge "set" anger POSIX-åtkomstkontrollrättigheter för filer och kataloger, "ändra" ändrar en eller flera POSIX-åtkomstkontrollrättigheter som redan finns på filer och kataloger, "ta bort" tar bort en eller flera POSIX-åtkomstkontrollrättigheter som fanns tidigare på filer och kataloger |
|
position
|
query |
integer (int64) |
Med den här parametern kan anroparen ladda upp data parallellt och styra i vilken ordning den läggs till i filen. Det krävs när du laddar upp data som ska läggas till i filen och vid tömning av tidigare uppladdade data till filen. Värdet måste vara den position där data ska läggas till. Uppladdade data rensas inte omedelbart, eller skrivs, till filen. För att rensa måste de tidigare uppladdade data vara sammanhängande, positionsparametern måste anges och vara lika med filens längd när alla data har skrivits och det får inte finnas en entitetstext för begäran som ingår i begäran. |
|
retain
|
query |
boolean |
Gäller endast för tömningsåtgärder. Om "sant" behålls ogenomförda data när tömningsåtgärden har slutförts. Annars tas de ogenomförda data bort efter tömningsåtgärden. Standardvärdet är falskt. Data vid förskjutningar som är mindre än den angivna positionen skrivs till filen när tömningen lyckas, men med den här valfria parametern kan data efter tömningspositionen behållas för en framtida tömningsåtgärd. |
|
timeout
|
query |
integer (int32) minimum: 1 |
Ett valfritt timeout-värde för åtgärden i sekunder. Perioden börjar när begäran tas emot av tjänsten. Om tidsgränsvärdet förflutit innan åtgärden slutförs misslyckas åtgärden. |
Begärandehuvud
Media Types: "application/octet-stream", "text/plain"
Name | Obligatorisk | Typ | Description |
---|---|---|---|
Content-Length |
integer (int64) minimum: 0 |
Krävs för "Lägg till data" och "Töm data". Måste vara 0 för "Flush Data". Måste vara längden på begärandeinnehållet i byte för "Lägg till data". |
|
Content-MD5 |
string |
Valfritt. En MD5-hash för begärandeinnehållet. Det här huvudet är giltigt för åtgärderna "Lägg till" och "Töm". Denna hash används för att verifiera integriteten för begärandeinnehållet under transporten. När det här huvudet har angetts jämför lagringstjänsten hash-värdet för det innehåll som har anlänt med det här rubrikvärdet. Om de två hashvärdena inte matchar misslyckas åtgärden med felkoden 400 (felaktig begäran). Observera att denna MD5-hash inte lagras med filen. Det här huvudet är associerat med begärandeinnehållet och inte med det lagrade innehållet i själva filen. |
|
x-ms-lease-id |
string pattern: ^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$ |
Låne-ID måste anges om det finns ett aktivt lån. Ogiltigt för "setAccessControlRecursive"-åtgärder. |
|
x-ms-cache-control |
string |
Valfritt och endast giltigt för åtgärder för att rensa och ange egenskaper. Tjänsten lagrar det här värdet och innehåller det i svarshuvudet "Cache-Control" för "Läs fil"-åtgärder. |
|
x-ms-content-type |
string |
Valfritt och endast giltigt för åtgärder för att rensa och ange egenskaper. Tjänsten lagrar det här värdet och inkluderar det i svarshuvudet "Innehållstyp" för "Läs fil"-åtgärder. |
|
x-ms-content-disposition |
string |
Valfritt och endast giltigt för åtgärder för att rensa och ange egenskaper. Tjänsten lagrar det här värdet och innehåller det i svarshuvudet "Content-Disposition" för "Läs fil"-åtgärder. |
|
x-ms-content-encoding |
string |
Valfritt och endast giltigt för åtgärder för att rensa och ange egenskaper. Tjänsten lagrar det här värdet och innehåller det i svarshuvudet "Content-Encoding" för "Läs fil"-åtgärder. |
|
x-ms-content-language |
string |
Valfritt och endast giltigt för åtgärder för att rensa och ange egenskaper. Tjänsten lagrar det här värdet och innehåller det i svarshuvudet "Content-Language" för "Läs fil"-åtgärder. |
|
x-ms-content-md5 |
string |
Valfritt och endast giltigt för åtgärder för att rensa och ange egenskaper. Tjänsten lagrar det här värdet och innehåller det i svarshuvudet "Content-Md5" för åtgärderna "Läsa och hämta egenskaper". Om den här egenskapen inte anges i begäran rensas egenskapen för filen. Efterföljande anrop till "Läs och Hämta egenskaper" returnerar inte den här egenskapen om den inte uttryckligen har angetts för filen igen. |
|
x-ms-properties |
string |
Valfritt. Användardefinierade egenskaper som ska lagras med filen eller katalogen, i formatet för en kommaavgränsad lista med namn- och värdepar "n1=v1, n2=v2, ...", där varje värde är en base64-kodad sträng. Observera att strängen bara får innehålla ASCII-tecken i teckenuppsättningen ISO-8859-1. Gäller endast för setProperties-åtgärden. Om filen eller katalogen finns tas alla egenskaper som inte ingår i listan bort. Alla egenskaper tas bort om rubriken utelämnas. Om du vill sammanfoga nya och befintliga egenskaper hämtar du först alla befintliga egenskaper och den aktuella E-taggen och gör sedan en villkorlig begäran med E-taggen och inkluderar värden för alla egenskaper. |
|
x-ms-owner |
string |
Valfritt och giltigt endast för setAccessControl-åtgärden. Anger ägaren till filen eller katalogen. |
|
x-ms-group |
string |
Valfritt och giltigt endast för setAccessControl-åtgärden. Anger den ägande gruppen för filen eller katalogen. |
|
x-ms-permissions |
string |
Valfritt och endast giltigt om hierarkiskt namnområde är aktiverat för kontot. Anger POSIX-åtkomstbehörigheter för filägaren, filägargruppen och andra. Varje klass kan beviljas läsbehörighet (4), skrivbehörighet (2) eller köra (1). Både symbolisk (rwxrw-rw-) och 4-siffrig oktal notation (t.ex. 0766) stöds. Den klibbiga biten stöds också och i symbolisk notation, representeras den antingen av bokstaven t eller T på den slutliga teckenplatsen beroende på om körningsbiten för den andra kategorin anges respektive tas bort (t.ex. rwxrw-rw- med fästbit representeras som rwxrw-rwT. En rwxrw-rwx med klibbig bit representeras som rwxrw-rwt), frånvaro av t eller T indikerar att klibbig bit inte har angetts. I 4-siffrig oktal notation representerar dess med en siffra (t.ex. 1766 representerar rwxrw-rw- med klibbig bit och 0766 representerar rwxrw-rw- utan klibbig bit). Ogiltigt tillsammans med x-ms-acl. |
|
x-ms-acl |
string |
Valfritt och giltigt endast för setAccessControl- och setAccessControlRecursive-åtgärder. Krävs för setAccessControlRecursive-åtgärden. Anger behörigheter för POSIX-åtkomstkontroll för filer och kataloger. Värdet är en kommaavgränsad lista över åtkomstkontrollposter som helt ersätter den befintliga åtkomstkontrollistan (ACL) vid setAccessControl och "set"-läge för setAccessControlRecursive. "ändra" läge för setAccessControlRecursive uppdaterar den befintliga ACLS. Varje åtkomstkontrollpost (ACE) består av ett omfång, en typ, en användare eller gruppidentifierare och behörigheter i formatet "[scope:][type]:[id]:[permissions]". Omfånget måste vara "standard" för att ange att ACE tillhör standard-ACL:en för en katalog. annars är omfånget implicit och ACE tillhör åtkomst-ACL:en. Det finns fyra ACE-typer: "användare" beviljar rättigheter till ägaren eller en namngiven användare, "grupp" beviljar rättigheter till den ägande gruppen eller en namngiven grupp, "mask" begränsar rättigheter som beviljas till namngivna användare och medlemmar i grupper, och "andra" ger rättigheter till alla användare som inte finns i någon av de andra posterna. Användaren eller gruppidentifieraren utelämnas för poster av typen "mask" och "other". Användaren eller gruppidentifieraren utelämnas också för ägaren och ägande gruppen. Behörighetsfältet är en sekvens på 3 tecken där det första tecknet är "r" för att bevilja läsåtkomst, det andra tecknet är "w" för att bevilja skrivåtkomst och det tredje tecknet är "x" för att bevilja körningsbehörighet. Om åtkomst inte beviljas används tecknet "-" för att ange att behörigheten nekas. Följande ACL beviljar till exempel läs-, skriv- och körningsrättigheter till filägaren och john.doe@contoso, läsbehörigheten till ägande gruppen och ingenting till alla andra: "user::rwx,user:john.doe@contoso:rwx,group::r--,other::---,mask=rwx". Ogiltigt tillsammans med x-ms-permissions. "remove"-läget för setAccessControlRecursive tar bort befintliga ACL:er och bör inte innehålla behörigheter i åtkomstkontrollistan som anges: "user:john.doe@contoso:, mask:". "set"-läget för setAccessControlRecursive anger ACL:er som ersätter de befintliga ACL:erna för det angivna omfånget och måste innehålla alla tre – ägande användare, ägande grupp och annan information om åtkomstomfånget anges eller om någon av ägande användare, ägande grupp eller annan anges i standardomfånget. Lägena "set" och "modify" för setAccessControlRecursive måste innehålla behörigheter som en del av åtkomstkontrollistan. |
|
If-Match |
string |
Valfritt för Töm data, Ange åtkomstkontroll och Ange egenskaper, men ogiltigt för Tilläggsdata och Ange rekursiv åtkomstkontroll. Ett ETag-värde. Ange det här huvudet för att utföra åtgärden endast om resursens ETag matchar det angivna värdet. ETag måste anges inom citattecken. |
|
If-None-Match |
string |
Valfritt för Töm data, Ange åtkomstkontroll och Ange egenskaper, men ogiltigt för Tilläggsdata och Ange rekursiv åtkomstkontroll. Ett ETag-värde eller ett särskilt jokerteckenvärde ("*"). Ange det här huvudet för att utföra åtgärden endast om resursens ETag inte matchar det angivna värdet. ETag måste anges inom citattecken. |
|
If-Modified-Since |
string |
Valfritt för Töm data och Ange egenskaper, men ogiltigt för Tilläggsdata och Ange rekursiv åtkomstkontroll. Ett datum- och tidsvärde. Ange det här huvudet för att utföra åtgärden endast om resursen har ändrats sedan det angivna datumet och tiden. |
|
If-Unmodified-Since |
string |
Valfritt för Töm data och Ange egenskaper, men ogiltigt för Tilläggsdata och Ange rekursiv åtkomstkontroll. Ett datum- och tidsvärde. Ange det här huvudet för att utföra åtgärden endast om resursen inte har ändrats sedan det angivna datumet och tiden. |
|
x-ms-encryption-key |
string |
Valfritt. Den Base64-kodade AES-256-krypteringsnyckeln. |
|
x-ms-encryption-key-sha256 |
string |
Valfritt. Den Base64-kodade SHA256-hashen för krypteringsnyckeln. |
|
x-ms-encryption-algorithm: AES256 |
string |
Valfritt. Anger den algoritm som ska användas för kryptering. Värdet för det här huvudet måste vara AES256. |
|
x-ms-lease-action | True |
Från och med version 2020-08-04 i tilläggs- och tömningsåtgärder. Appen har stöd för åtgärden "acquire", "auto-renew" och "acquire-release". Om "förvärvar" kommer det att förvärva lånet. Om "förnyas automatiskt" förnyas lånet. Om "acquire-release" hämtas & slutföra åtgärden & frigöra lånet när åtgärden är klar. Åtgärden "Release" stöds endast i tömningsåtgärden. Om "true" släpps lånet för filen med hjälp av låne-ID-informationen från rubriken x-ms-lease-id. |
|
x-ms-lease-duration |
integer (int32) |
Lånetiden krävs för att förvärva ett lån och anger lånets varaktighet i sekunder. Lånetiden måste vara mellan 15 och 60 sekunder eller -1 för oändligt lån. |
|
x-ms-proposed-lease-id |
string pattern: ^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$ |
Krävs när "x-ms-lease-action" är "acquire" eller "change". Ett lån hämtas med det här låne-ID:t om åtgärden lyckas. |
|
x-ms-client-request-id |
string pattern: ^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$ |
Ett UUID som registrerats i analysloggarna för felsökning och korrelation. |
|
x-ms-date |
string |
Anger UTC (Coordinated Universal Time) för begäran. Detta krävs när du använder auktorisering av delad nyckel. |
|
x-ms-version |
string |
Anger den version av REST-protokollet som används för bearbetning av begäran. Detta krävs när du använder auktorisering av delad nyckel. |
Begärandetext
Media Types: "application/octet-stream", "text/plain"
Name | Typ | Description |
---|---|---|
requestBody |
object (file) |
Gäller endast för tilläggsåtgärder. De data som ska laddas upp och läggas till i filen. |
Svar
Name | Typ | Description |
---|---|---|
200 OK |
Data har tömts (skrivits) till filen eller så har egenskaperna angetts. Svarstexten är valfri och är endast giltig för "SetAccessControlRecursive" Sidhuvuden
|
|
202 Accepted |
De uppladdade data accepterades. Sidhuvuden
|
|
Other Status Codes |
Ett fel uppstod. De möjliga HTTP-status-, kod- och meddelandesträngarna visas nedan:
Sidhuvuden
|
Definitioner
Name | Description |
---|---|
Acl |
|
Data |
|
Error |
Tjänstens felsvarsobjekt. |
Path |
Från och med version 2020-08-04 i tilläggs- och tömningsåtgärder. Appen har stöd för åtgärden "acquire", "auto-renew" och "acquire-release". Om "förvärvar" kommer det att förvärva lånet. Om "förnyas automatiskt" förnyas lånet. Om "acquire-release" hämtas & slutföra åtgärden & frigöra lånet när åtgärden är klar. Åtgärden "Release" stöds endast i tömningsåtgärden. Om "true" släpps lånet för filen med hjälp av låne-ID-informationen från rubriken x-ms-lease-id. |
Path |
Åtgärden måste vara "tillägg" för att ladda upp data som ska läggas till i en fil, "rensa" för att rensa tidigare uppladdade data till en fil, "setProperties" för att ange egenskaperna för en fil eller katalog, eller "setAccessControl" för att ange ägare, grupp, behörigheter eller åtkomstkontrolllista för en fil eller katalog, eller "setAccessControlRecursive" för att ange åtkomstkontrollistan för en katalog rekursivt. Observera att hierarkiskt namnområde måste vara aktiverat för kontot för att kunna använda åtkomstkontroll. Observera också att åtkomstkontrollistan (ACL) innehåller behörigheter för ägaren, ägande gruppen och andra, så att x-ms-permissions- och x-ms-acl-begäranderubrikerna är ömsesidigt uteslutande. |
Set |
AclFailedEntryList
Name | Typ | Description |
---|---|---|
errorMessage |
string |
|
name |
string |
|
type |
string |
DataLakeStorageError
Name | Typ | Description |
---|---|---|
error |
Tjänstens felsvarsobjekt. |
Error
Tjänstens felsvarsobjekt.
Name | Typ | Description |
---|---|---|
code |
string |
Felkoden för tjänsten. |
message |
string |
Tjänstens felmeddelande. |
PathLeaseAction
Från och med version 2020-08-04 i tilläggs- och tömningsåtgärder. Appen har stöd för åtgärden "acquire", "auto-renew" och "acquire-release". Om "förvärvar" kommer det att förvärva lånet. Om "förnyas automatiskt" förnyas lånet. Om "acquire-release" hämtas & slutföra åtgärden & frigöra lånet när åtgärden är klar. Åtgärden "Release" stöds endast i tömningsåtgärden. Om "true" släpps lånet för filen med hjälp av låne-ID-informationen från rubriken x-ms-lease-id.
Värde | Description |
---|---|
acquire | |
acquire-release | |
auto-renew | |
release |
PathUpdateAction
Åtgärden måste vara "tillägg" för att ladda upp data som ska läggas till i en fil, "rensa" för att rensa tidigare uppladdade data till en fil, "setProperties" för att ange egenskaperna för en fil eller katalog, eller "setAccessControl" för att ange ägare, grupp, behörigheter eller åtkomstkontrolllista för en fil eller katalog, eller "setAccessControlRecursive" för att ange åtkomstkontrollistan för en katalog rekursivt. Observera att hierarkiskt namnområde måste vara aktiverat för kontot för att kunna använda åtkomstkontroll. Observera också att åtkomstkontrollistan (ACL) innehåller behörigheter för ägaren, ägande gruppen och andra, så att x-ms-permissions- och x-ms-acl-begäranderubrikerna är ömsesidigt uteslutande.
Värde | Description |
---|---|
append | |
flush | |
setAccessControl | |
setAccessControlRecursive | |
setProperties |
SetAccessControlRecursiveResponse
Name | Typ | Description |
---|---|---|
directoriesSuccessful |
integer (int32) |
|
failedEntries | ||
failureCount |
integer (int32) |
|
filesSuccessful |
integer (int32) |