Del via

Items - Delete Environment

Tjeneste:
Environment
API-versjon:
v1

Sletter det angitte miljøet.

Tillatelser

Innringeren må ha skrivetillatelser for miljøet.

Nødvendige delegerte omfang

Environment.ReadWrite.All eller Item.ReadWrite.All

Microsoft Entra-støttede identiteter

Denne API-en støtter Microsoft -identiteter oppført i denne delen.

Identitet Kundestøtte
Bruker Ja
tjenestekontohaver og administrerte identiteter Ja

Grensesnitt

DELETE https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/environments/{environmentId}
Med valgfrie parametere: 
DELETE https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/environments/{environmentId}?hardDelete={hardDelete}

URI-parametere

Navn I Obligatorisk Type Beskrivelse
environmentId
 path True

string (uuid)

Miljø-ID-en.
workspaceId
 path True

string (uuid)

Arbeidsområde-ID-en.
hardDelete
 query

boolean

Angir om det skal utføres en hard sletting. Når det er satt til true, slettes elementet permanent og kan ikke gjenopprettes. Når det er angitt eller false ikke angitt, slettes elementet mykt hvis elementtypen støtter det.

Svar

Navn Type Beskrivelse
200 OK

Forespørselen er fullført.
429 Too Many Requests

ErrorResponse

Grensen for tjenestesats ble overskredet. Serveren returnerer en Retry-After topptekst som angir, i sekunder, hvor lenge klienten må vente før du sender flere forespørsler.

Overskrifter

Retry-After: integer
Other Status Codes

ErrorResponse

Vanlige feilkoder:

  • ItemNotFound – Finner ikke det forespurte elementet.

  • InsufficientWorkspaceRole – brukeren har ikke tilstrekkelig arbeidsområderolle.

  • FeatureNotAvailable – Dette kan skyldes at funksjonen for myk sletting ikke er tilgjengelig.

  • Ikke støttetItemType – Dette kan skyldes at funksjonen for myk sletting ikke støttes av den forespurte elementtypen.

  • TenantSwitchDisabled – Dette kan skyldes at funksjonen for myk sletting deaktiveres av leieradministratoren.

  • InvalidTargetItemStateForSoftDeletion – elementet er i ugyldige statuser for myk sletting.

  • InvalidParentItemStateForSoftDeletion – elementets overordnede element er ikke i aktiv tilstand.

Eksempler

Delete an environment example
Hard delete an environment example

Delete an environment example

Eksempelforespørsel

DELETE https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/environments/5b218778-e7a5-4d73-8187-f10824047715

Eksempelsvar

Statuskode:
200

Hard delete an environment example

Eksempelforespørsel

DELETE https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/environments/5b218778-e7a5-4d73-8187-f10824047715?hardDelete=True

Eksempelsvar

Statuskode:
200

Definisjoner

Navn Beskrivelse
ErrorRelatedResource

Objektet for feilrelaterte ressursdetaljer.
ErrorResponse

Feilsvaret.
ErrorResponseDetails

Feilsvardetaljene.

ErrorRelatedResource

Objekt

Objektet for feilrelaterte ressursdetaljer.

Navn Type Beskrivelse
resourceId

string

Ressurs-ID-en som er involvert i feilen.
resourceType

string

Typen ressurs som er involvert i feilen.

ErrorResponse

Objekt

Feilsvaret.

Navn Type Beskrivelse
errorCode

string

En bestemt identifikator som gir informasjon om en feilbetingelse, noe som gir standardisert kommunikasjon mellom tjenesten og brukerne.
message

string

En menneskelig lesbar representasjon av feilen.
moreDetails

ErrorResponseDetails[]

Liste over flere feildetaljer.
relatedResource

ErrorRelatedResource

Feilrelaterte ressursdetaljer.
requestId

string (uuid)

ID for forespørselen som er knyttet til feilen.

ErrorResponseDetails

Objekt

Feilsvardetaljene.

Navn Type Beskrivelse
errorCode

string

En bestemt identifikator som gir informasjon om en feilbetingelse, noe som gir standardisert kommunikasjon mellom tjenesten og brukerne.
message

string

En menneskelig lesbar representasjon av feilen.
relatedResource

ErrorRelatedResource

Feilrelaterte ressursdetaljer.