Share verwijderen (FileREST API) - Azure Files

Artikel
07/19/2023

De Delete Share bewerking verwijdert de opgegeven share of momentopname van de share. Deze API wordt volledig ondersteund, maar houd er rekening mee dat dit een verouderde beheer-API is.

Het is een goed idee om in plaats daarvan Bestandsshares - Verwijderen te gebruiken. Deze wordt geleverd door de opslagresourceprovider (Microsoft.Storage). Zie Bewerkingen op Bestandsshares voor meer informatie over programmatische interactie met FileShare resources met behulp van de opslagresourceprovider.

Protocol beschikbaarheid

Bestandsshareprotocol ingeschakeld	Beschikbaar
SMB
NFS

Aanvraag

U kunt de Delete Share aanvraag als volgt samenstellen. HTTPS wordt aanbevolen.

Methode	Aanvraag-URI	HTTP-versie
`DELETE`	`https://myaccount.file.core.windows.net/myshare?restype=share`	HTTP/1.1
`DELETE`	`https://myaccount.file.core.windows.net/myshare?sharesnapshot=<DateTime>&restype=share`	HTTP/1.1

Vervang de padonderdelen die worden weergegeven in de aanvraag-URI door uw eigen, als volgt:

Padonderdeel	Beschrijving
`myaccount`	De naam van uw opslagaccount.
`myshare`	De naam van uw bestandsshare.

Zie Naamgeving en verwijzingen naar shares, mappen, bestanden en metagegevens voor meer informatie over padnaambeperkingen.

URI-parameters

U kunt de volgende aanvullende parameters opgeven in de aanvraag-URI.

Parameter	Beschrijving
`sharesnapshot`	Optioneel. Versie 2017-04-17 en hoger. De `sharesnapshot` parameter is een ondoorzichtige `DateTime` waarde die, indien aanwezig, de momentopname van de share aangeeft die moet worden verwijderd.
`timeout`	Optioneel. De `timeout` parameter wordt uitgedrukt in seconden. Zie Time-outs instellen voor Azure Files bewerkingen voor meer informatie.

Aanvraagheaders

In de volgende tabel worden vereiste en optionele aanvraagheaders beschreven.

Aanvraagheader	Beschrijving
`Authorization`	Vereist. Hiermee geeft u het autorisatieschema, de accountnaam en de handtekening op. Zie Aanvragen autoriseren voor Azure Storage voor meer informatie.
`Date` of `x-ms-date`	Vereist. Geef de Coordinated Universal Time (UTC) op voor de aanvraag. Zie Aanvragen autoriseren voor Azure Storage voor meer informatie.
`x-ms-version`	Vereist voor alle geautoriseerde aanvragen. Hiermee geeft u de versie van de bewerking te gebruiken voor deze aanvraag. Zie Versiebeheer voor de Azure Storage-services voor meer informatie.
`x-ms-delete-snapshots: { include, include-leased }`	Optioneel als de share gekoppelde momentopnamen bevat. Geef een van de volgende opties op: `include`: verwijder de basisshare en alle momentopnamen. `include-leased`: Versie 2020-02-10 en hoger. Verwijder de basisshare en alle bijbehorende momentopnamen, zelfs als een of meer momentopnamen actieve share-leases hebben.
`x-ms-client-request-id`	Optioneel. Biedt een door de client gegenereerde, ondoorzichtige waarde met een limiet 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 Azure Files bewaken voor meer informatie.
`x-ms-lease-id: <ID>`	Vereist als de doelbestandsshare een actieve lease heeft. Beschikbaar voor versie 2020-02-10 en hoger. Als de aanvraag de lease-id niet bevat of niet geldig is, mislukt de bewerking met statuscode 412 (Voorwaarde is mislukt). Als deze header is opgegeven en de doelbestandsshare momenteel geen actieve lease heeft, mislukt de bewerking ook met statuscode 412 (Voorwaarde mislukt).

Aanvraagbody

Geen.

Voorbeeldaanvraag

DELETE https://myaccount.file.core.windows.net/myshare?restype=share HTTP/1.1  
  
Request Headers:  
x-ms-version: 2014-02-14  
x-ms-date: Mon, 27 Jan 2014 22:50:32 GMT  
Authorization: SharedKey myaccount:Z5043vY9MesKNh0PNtksNc9nbXSSqGHueE00JdjidOQ= TBD

Antwoord

Het antwoord bevat een HTTP-statuscode en een set antwoordheaders.

Statuscode

Een geslaagde bewerking retourneert statuscode 202 (Geaccepteerd). Zie Status- en foutcodes voor meer informatie over statuscodes.

Antwoordheaders

Het antwoord voor deze bewerking bevat de volgende headers. Het antwoord kan ook extra, standaard HTTP-headers bevatten. Alle standaardheaders voldoen aan de HTTP/1.1-protocolspecificatie.

Antwoordheader	Beschrijving
`x-ms-request-id`	Deze header identificeert op unieke wijze de aanvraag die is gedaan en kan worden gebruikt voor het oplossen van problemen met de aanvraag. Zie Problemen met API-bewerkingen oplossen voor meer informatie.
`x-ms-version`	Geeft de versie aan van Azure Files gebruikt om de aanvraag uit te voeren.
`Date` of `x-ms-date`	Een UTC-datum/tijd-waarde die de tijd aangeeft waarop het antwoord is gestart. De service genereert deze waarde.
`x-ms-client-request-id`	U kunt deze header gebruiken 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. De waarde is maximaal 1024 zichtbare ASCII-tekens. Als de `x-ms-client-request-id` header niet aanwezig is in de aanvraag, is deze header niet aanwezig in het antwoord.

Hoofdtekst van de reactie

Geen.

Autorisatie

Alleen de accounteigenaar kan deze bewerking aanroepen.

Opmerkingen

Wanneer u een share verwijdert, kunt u gedurende ten minste 30 seconden geen share met dezelfde naam maken. Terwijl de share wordt verwijderd, mislukken pogingen om een share met dezelfde naam opnieuw te maken met statuscode 409 (conflict). De service retourneert aanvullende foutinformatie, waarmee wordt aangegeven dat de share wordt verwijderd. Alle andere bewerkingen, inclusief bewerkingen op alle bestanden onder de share, mislukken met statuscode 404 (Niet gevonden) terwijl de share wordt verwijderd.

Op dit moment is het verwijderen van een share met momentopnamen niet toegestaan. De momentopnamen van de share kunnen afzonderlijk worden verwijderd of samen met de share worden verwijderd met behulp van de x-ms-delete-snapshots=include header.

U moet alleen opgeven x-ms-delete-snapshots voor een aanvraag voor de resource van de basisshare. Als u deze header opgeeft voor een aanvraag om een afzonderlijke momentopname te verwijderen, retourneert Azure Files statuscode 400 (ongeldige queryparameterwaarde). Als deze header niet is opgegeven in de verwijderingsaanvraag en de share gekoppelde momentopnamen heeft, retourneert de Azure Files statuscode 409 (Share bevat momentopnamen).

Zie ook

Bewerkingen op shares (Azure Files)

Delen via