OneLake Settings - Modify Immutability Policy

Opret eller opdater indstillingerne for OneLake-uforanderlighed.
Angiv politik for uforanderlighed for data, der er gemt i OneLake. Denne funktion understøtter i øjeblikket konfiguration af en opbevaringsperiode specifikt til diagnosticeringslogge i et arbejdsområde, hvilket sikrer, at de forbliver uændrede, når de er skrevet.

Tilladelser

Den, der ringer op, skal have en administratorarbejdsområderolle.

Påkrævede delegerede områder

OneLake.ReadWrite.All

Begrænsninger

Kan kun anvendes, hvis:

  • Det aktuelle arbejdsområde gemmer diagnosticeringslogge fra andre arbejdsområder.
  • Der er allerede anvendt en opbevaringsperiode på diagnosticeringslogfilerne i arbejdsområdet

Microsoft Entra-understøttede identiteter

Denne API understøtter de Microsoft -identiteter, der angivet i dette afsnit.

Identitet Støtte
Bruger Ja
tjenesteprincipal og administrerede identiteter Ja

Grænseflade

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/onelake/settings/modifyImmutabilityPolicy

URI-parametre

Navn I Påkrævet Type Beskrivelse
workspaceId
path True

string (uuid)

Arbejdsområde-id'et.

Brødtekst for anmodning

Navn Påkrævet Type Beskrivelse
retentionDays True

integer

minimum: 1

Opbevaringsdage for handlingen.

scope True

ImmutabilityScope

Omfanget af den aktuelle indstilling for uforanderlighed.

Svar

Navn Type Beskrivelse
200 OK

Anmodningen blev fuldført.

429 Too Many Requests

ErrorResponse

Grænsen for tjenestetakst blev overskredet. Serveren returnerer en Retry-After header, der angiver, i sekunder, hvor længe klienten skal vente, før der sendes yderligere anmodninger.

Headere

Retry-After: integer

Other Status Codes

ErrorResponse

Almindelige fejlkoder:

  • UserNotAuthorized – Brugeren skal være administrator af arbejdsområdet for at aktivere diagnosticeringsindstillinger.

  • WorkspaceNotFound - Arbejdsområdet blev ikke fundet.

  • RetentionDaysReductionNotAllowed – Opbevaringsdage kan ikke reduceres, end hvad der allerede er angivet.

  • WorkspaceNotSupported – Arbejdsområdet understøttes ikke til angivelse af en politik for diagnosticerings uforanderlighed.

  • InternalServerError – Andre interne fejl.

Eksempler

Enable immutability for diagnostic logs example
Reduce retention days example (error case)

Enable immutability for diagnostic logs example

Eksempelanmodning

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff227/onelake/settings/modifyImmutabilityPolicy

{
  "scope": "DiagnosticLogs",
  "retentionDays": 7
}

Eksempelsvar

Reduce retention days example (error case)

Eksempelanmodning

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff227/onelake/settings/modifyImmutabilityPolicy

{
  "scope": "DiagnosticLogs",
  "retentionDays": 3
}

Eksempelsvar

{
  "requestId": "e7d4be9d-423c-4b26-b4e4-35de77c89e26",
  "errorCode": "BadRequest",
  "moreDetails": [
    {
      "errorCode": "RetentionDaysReductionNotAllowed ",
      "message": "",
      "relatedResource": {
        "resourceId": "4a0afce7-520f-4542-b7ff-6f6252c7008b",
        "resourceType": "Workspace"
      }
    }
  ],
  "message": "The request could not be processed due to missing or invalid information",
  "relatedResource": {
    "resourceId": "4a0afce7-520f-4542-b7ff-6f6252c7008b",
    "resourceType": "Workspace"
  }
}

Definitioner

Navn Beskrivelse
ErrorParameter

En struktureret parameter, der giver yderligere kontekst, der kan læses af computeren, om en fejl.

ErrorRelatedResource

Objektet med fejlrelaterede ressourceoplysninger.

ErrorResponse

Fejlsvaret.

ErrorResponseDetails

Oplysninger om fejlsvar.

ImmutabilityPolicyRequest

Objekt til anmodning om uforanderlighed for politik.

ImmutabilityScope

Omfanget af uforanderlighedspolitik. Der kan tilføjes flere områdetyper for uforanderlighed over tid.

ErrorParameter

En struktureret parameter, der giver yderligere kontekst, der kan læses af computeren, om en fejl.

Navn Type Beskrivelse
message

string

En læsevenlig beskrivelse af parameterens betydning.

name

string

Parameter-id'et.

value

string

Parameterens værdi.

ErrorRelatedResource

Objektet med fejlrelaterede ressourceoplysninger.

Navn Type Beskrivelse
resourceId

string

Det ressource-id, der er involveret i fejlen.

resourceType

string

Typen af ressource, der er involveret i fejlen.

ErrorResponse

Fejlsvaret.

Navn Type Beskrivelse
errorCode

string

Et bestemt id, der indeholder oplysninger om en fejltilstand, der muliggør standardiseret kommunikation mellem vores tjeneste og dens brugere.

isRetriable

boolean

Når sand, kan anmodningen prøves igen. Brug svarheaderen Retry-After til at bestemme forsinkelsen, hvis den er tilgængelig.

message

string

En menneskelig læsbar gengivelse af fejlen.

moreDetails

ErrorResponseDetails[]

Liste over yderligere oplysninger om fejl.

parameters

ErrorParameter[]

Strukturerede parametre, der giver yderligere kontekst, der kan læses af computeren, om fejlen.

relatedResource

ErrorRelatedResource

De fejlrelaterede ressourceoplysninger.

requestId

string (uuid)

Id'et for den anmodning, der er knyttet til fejlen.

ErrorResponseDetails

Oplysninger om fejlsvar.

Navn Type Beskrivelse
errorCode

string

Et bestemt id, der indeholder oplysninger om en fejltilstand, der muliggør standardiseret kommunikation mellem vores tjeneste og dens brugere.

message

string

En menneskelig læsbar gengivelse af fejlen.

parameters

ErrorParameter[]

Strukturerede parametre, der giver yderligere kontekst, der kan læses af computeren, om fejlen.

relatedResource

ErrorRelatedResource

De fejlrelaterede ressourceoplysninger.

ImmutabilityPolicyRequest

Objekt til anmodning om uforanderlighed for politik.

Navn Type Beskrivelse
retentionDays

integer

minimum: 1

Opbevaringsdage for handlingen.

scope

ImmutabilityScope

Omfanget af den aktuelle indstilling for uforanderlighed.

ImmutabilityScope

Omfanget af uforanderlighedspolitik. Der kan tilføjes flere områdetyper for uforanderlighed over tid.

Værdi Beskrivelse
DiagnosticLogs

Uforanderlighedspolitik for diagnosticeringslogge.