OneLake Settings - Modify Diagnostics

Aktiverer eller deaktiverer indstillingerne for OneLake-diagnosticering i arbejdsområdet.
Denne API understøtter LRO-handlinger (Long Running Operations).

Rettigheder

  • Den kaldende skal have en administratorarbejdsområderolle i kildearbejdsområdet.

  • Den, der ringer op, skal have en bidragyderrolle eller en rolle over arbejdsområdet i destinationsarbejdsområdet.

Påkrævede delegerede områder

OneLake.ReadWrite.All

Microsoft Entra-understøttede identiteter

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

Identity Støtte
User Ja
tjenesteprincipal og administrerede identiteter Ja

Interface

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

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
status True

string

Status for diagnosticeringsindstillingerne.

destination OneLakeDiagnosticSettingsDestinationInfo:

LakehouseOneLakeDiagnosticSettingsDestination

Den destination, hvor OneLake-diagnosticeringslogge gemmes. Hvis du deaktiverer, er dette ikke påkrævet.

Svar

Navn Type Beskrivelse
200 OK

Anmodningen blev fuldført.

202 Accepted

Anmodningen blev accepteret. Ændring af diagnosticeringsindstillinger er i gang.

Headere

  • Location: string
  • x-ms-operation-id: string
  • Retry-After: integer
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:

  • UnknownError – Der opstod en fejl.

  • WorkspaceNotFound – Kildearbejdsområde blev ikke fundet.

  • UserNotAuthorizedSourceWorkspace – Brugeren er ikke godkendt til kildearbejdsområdet.

  • UserNotAuthorizedDestinationItem – Brugeren er ikke godkendt til destinationsarbejdsområdet.

  • DestinationWorkspaceNotFound - Destinationsarbejdsområdet blev ikke fundet.

  • DestinationItemNotFound -Destination element blev ikke fundet.

  • WorkspaceNotInSameCapacity – Kilde- og destinationsarbejdsområde, der ikke har samme kapacitet.

  • SettingsNotAllowedOnWorkspace – Diagnosticeringsindstilling er ikke tilladt i arbejdsområdet.

  • RequiredDestination – Destination er påkrævet, når diagnosticering aktiveres første gang.

Eksempler

Create OneLake Diagnostic Setting for Workspace example
Disable OneLake Diagnostic Setting for Workspace example
Remove OneLake Diagnostic Setting Destination for Workspace example
Replace OneLake Diagnostic Setting Destination for Workspace example

Create OneLake Diagnostic Setting for Workspace example

Eksempelanmodning

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

{
  "status": "Enabled",
  "destination": {
    "type": "Lakehouse",
    "lakehouse": {
      "referenceType": "ById",
      "itemId": "eceb53c6-6227-41f1-a649-62ebe7ee9eb1",
      "workspaceId": "85173301-af01-49c9-b667-03edc44517da"
    }
  }
}

Eksempelsvar

Disable OneLake Diagnostic Setting for Workspace example

Eksempelanmodning

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

{
  "status": "Disabled"
}

Eksempelsvar

Remove OneLake Diagnostic Setting Destination for Workspace example

Eksempelanmodning

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

{
  "status": "Disabled",
  "destination": {
    "type": "Lakehouse"
  }
}

Eksempelsvar

Replace OneLake Diagnostic Setting Destination for Workspace example

Eksempelanmodning

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

{
  "status": "Enabled",
  "destination": {
    "type": "Lakehouse",
    "lakehouse": {
      "referenceType": "ById",
      "itemId": "83b128a3-f58f-4eee-ab0b-e7e25a748f54",
      "workspaceId": "6eb233d7-b1c6-4248-9255-5a0d223f3456"
    }
  }
}

Eksempelsvar

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.

ItemReferenceById

En elementreference efter id-objekt.

ItemReferenceByVariable

En elementreference efter variabel.

ItemReferenceType

Elementreferencetypen. Der kan tilføjes flere ItemReferenceType typer over tid.

LakehouseOneLakeDiagnosticSettingsDestination

Lakehouse-destination for OneLake-diagnosticeringslogge.

OneLakeDiagnosticSettings

OneLake-objekt til diagnosticeringsindstillinger.

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.

ItemReferenceById

En elementreference efter id-objekt.

Navn Type Beskrivelse
itemId

string (uuid)

Id'et for elementet.

referenceType string:

ById

Elementreferencetypen.

workspaceId

string (uuid)

Elementets arbejdsområde-id.

ItemReferenceByVariable

En elementreference efter variabel.

Navn Type Beskrivelse
referenceType string:

ByVariable

Elementreferencetypen.

variableReference

string

En variabelreferencestreng, der angiver variabelbiblioteket og variabelnavnet i det. Format: $(/**/_VarLibrary_/_VarName_) for et variabelbibliotek med navnet VarLibrary og en variabel med navnet VarName.

ItemReferenceType

Elementreferencetypen. Der kan tilføjes flere ItemReferenceType typer over tid.

Værdi Beskrivelse
ById

Der refereres til elementet af dets id.

ByVariable

Der refereres til elementet af en variabel.

LakehouseOneLakeDiagnosticSettingsDestination

Lakehouse-destination for OneLake-diagnosticeringslogge.

Navn Type Beskrivelse
lakehouse ItemReference:

Reference til destinationssøhuset. I øjeblikket understøttes kun ItemReferenceById.

type string:

Lakehouse

Destinationens elementtype.

OneLakeDiagnosticSettings

OneLake-objekt til diagnosticeringsindstillinger.

Navn Type Beskrivelse
destination OneLakeDiagnosticSettingsDestinationInfo:

LakehouseOneLakeDiagnosticSettingsDestination

Den destination, hvor OneLake-diagnosticeringslogge gemmes. Hvis du deaktiverer, er dette ikke påkrævet.

status

string

Status for diagnosticeringsindstillingerne.