OneLake Settings - Get Settings
Hent OneLake-indstillinger for arbejdsområde.
Rettigheder
Den, der ringer op, skal have en administratorarbejdsområderolle.
Påkrævede delegerede områder
OneLake.Read.All eller 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
GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/onelake/settings
URI-parametre
| Navn | I | Påkrævet | Type | Beskrivelse |
|---|---|---|---|---|
|
workspace
|
path | True |
string (uuid) |
Arbejdsområde-id'et. |
Svar
| Navn | Type | Beskrivelse |
|---|---|---|
| 200 OK |
Anmodningen blev fuldført. |
|
| 429 Too Many Requests |
Grænsen for tjenestetakst blev overskredet. Serveren returnerer en Headere Retry-After: integer |
|
| Other Status Codes |
Almindelige fejlkoder:
|
Eksempler
Get OneLake Settings with all settings example
Eksempelanmodning
GET https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff227/onelake/settings
Eksempelsvar
{
"diagnostics": {
"status": "Enabled",
"destination": {
"type": "Lakehouse",
"lakehouse": {
"referenceType": "ById",
"itemId": "33d48b2c-5b7c-42e2-8467-87fecb105fdd",
"workspaceId": "85173301-af01-49c9-b667-03edc44517da"
}
}
},
"immutabilityPolicies": [
{
"scope": "DiagnosticLogs",
"retentionDays": 30
}
],
"lifecycle": {
"defaultTier": "Cool",
"policy": "Active",
"accessTimeTracking": "Enabled"
},
"fileSoftDelete": {
"status": "Enabled",
"retentionPeriodInDays": 7
}
}
Get OneLake Settings with diagnostics disabled example
Eksempelanmodning
GET https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff227/onelake/settings
Eksempelsvar
{
"diagnostics": {
"status": "Disabled"
},
"lifecycle": {
"defaultTier": "Hot",
"policy": "Inactive"
},
"fileSoftDelete": {
"status": "Disabled"
}
}
Get OneLake Settings with diagnostics enabled example
Eksempelanmodning
GET https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff227/onelake/settings
Eksempelsvar
{
"diagnostics": {
"status": "Enabled",
"destination": {
"type": "Lakehouse",
"lakehouse": {
"referenceType": "ById",
"itemId": "33d48b2c-5b7c-42e2-8467-87fecb105fdd",
"workspaceId": "85173301-af01-49c9-b667-03edc44517da"
}
}
},
"lifecycle": {
"defaultTier": "Cool",
"policy": "Active"
},
"fileSoftDelete": {
"status": "Enabled",
"retentionPeriodInDays": 7
}
}
Get OneLake Settings with immutability policy example
Eksempelanmodning
GET https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff227/onelake/settings
Eksempelsvar
{
"diagnostics": {
"status": "Enabled",
"destination": {
"type": "Lakehouse",
"lakehouse": {
"referenceType": "ById",
"itemId": "33d48b2c-5b7c-42e2-8467-87fecb105fdd",
"workspaceId": "85173301-af01-49c9-b667-03edc44517da"
}
}
},
"immutabilityPolicies": [
{
"scope": "DiagnosticLogs",
"retentionDays": 30
}
],
"lifecycle": {
"defaultTier": "Cool",
"policy": "Active"
},
"fileSoftDelete": {
"status": "Enabled",
"retentionPeriodInDays": 30
}
}
Get OneLake Settings without immutability policy example
Eksempelanmodning
GET https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff227/onelake/settings
Eksempelsvar
{
"diagnostics": {
"status": "Disabled"
},
"lifecycle": {
"defaultTier": "Hot",
"policy": "Inactive"
},
"fileSoftDelete": {
"status": "Enabled",
"retentionPeriodInDays": 7
}
}
Definitioner
| Navn | Beskrivelse |
|---|---|
|
Access |
Status for OneLake-adgangstidssporing. Når indstillingen er aktiveret, opdaterer Azure Storage egenskaben LastAccessTime for fillæsninger og -skrivning. Der kan tilføjes yderligere statusværdier over tid. |
|
Disabled |
Dette objekt repræsenterer deaktiverede indstillinger for blød sletning af filer for et arbejdsområde. Opbevaringsperioden udelades. |
|
Enabled |
Dette objekt indeholder de aktiverede indstillinger for blød sletning af filen og opbevaringsperioden for et arbejdsområde. |
|
Error |
En struktureret parameter, der giver yderligere kontekst, der kan læses af computeren, om en fejl. |
|
Error |
Objektet med fejlrelaterede ressourceoplysninger. |
|
Error |
Fejlsvaret. |
|
Error |
Oplysninger om fejlsvar. |
|
Get |
Svar på OneLake-indstillinger. |
|
Immutability |
Politikobjekt for uforanderlighed. |
|
Immutability |
Omfanget af uforanderlighedspolitik. Der kan tilføjes flere områdetyper for uforanderlighed over tid. |
|
Item |
En elementreference efter id-objekt. |
|
Item |
En elementreference efter variabel. |
|
Item |
Elementreferencetypen. Der kan tilføjes flere |
|
Lakehouse |
Lakehouse-destination for OneLake-diagnosticeringslogge. |
| Lifecycle |
Indstillinger for administration af livscyklus for arbejdsområdet. Kun til stede, når livscyklusstyring er aktiveret. |
|
One |
Adgangsniveauerne OneLake. Der kan tilføjes yderligere værdier for adgangsniveauer over tid. |
|
One |
OneLake-objekt til diagnosticeringsindstillinger. |
|
One |
Status for blød sletning af filen for et arbejdsområde. Der kan tilføjes yderligere statusværdier over tid. |
|
One |
Status for OneLake-livscykluspolitikken. Der kan tilføjes yderligere statusværdier over tid. |
AccessTimeTrackingStatus
Status for OneLake-adgangstidssporing. Når indstillingen er aktiveret, opdaterer Azure Storage egenskaben LastAccessTime for fillæsninger og -skrivning. Der kan tilføjes yderligere statusværdier over tid.
| Værdi | Beskrivelse |
|---|---|
| Enabled |
Registrering af adgangstid er aktiveret. Azure Storage opdaterer LastAccessTime ved læsning og skrivning af filer. |
| Disabled |
Registrering af adgangstid er deaktiveret. LastAccessTime opdateres ikke ved filadgang. |
DisabledOneLakeFileSoftDeleteSettings
Dette objekt repræsenterer deaktiverede indstillinger for blød sletning af filer for et arbejdsområde. Opbevaringsperioden udelades.
| Navn | Type | Beskrivelse |
|---|---|---|
| status |
string:
Disabled |
Filens status for blød sletning, der identificerer indstillingsvarianten. Når den er angivet til |
EnabledOneLakeFileSoftDeleteSettings
Dette objekt indeholder de aktiverede indstillinger for blød sletning af filen og opbevaringsperioden for et arbejdsområde.
| Navn | Type | Beskrivelse |
|---|---|---|
| retentionPeriodInDays |
integer (int32) minimum: 1maximum: 365 |
Antallet af dage, hvor slettede filer bevares, før de slettes permanent. Det gyldige interval er 1 til 365 dage. |
| status |
string:
Enabled |
Filens status for blød sletning, der identificerer indstillingsvarianten. Når den er angivet til |
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 |
| message |
string |
En menneskelig læsbar gengivelse af fejlen. |
| moreDetails |
Liste over yderligere oplysninger om fejl. |
|
| parameters |
Strukturerede parametre, der giver yderligere kontekst, der kan læses af computeren, om fejlen. |
|
| relatedResource |
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 |
Strukturerede parametre, der giver yderligere kontekst, der kan læses af computeren, om fejlen. |
|
| relatedResource |
De fejlrelaterede ressourceoplysninger. |
GetOneLakeSettingsResponse
Svar på OneLake-indstillinger.
| Navn | Type | Beskrivelse |
|---|---|---|
| diagnostics |
OneLake-objekt til diagnosticeringsindstillinger. |
|
| fileSoftDelete | OneLakeFileSoftDeleteSettings: |
Indstillinger for blød sletning af filer for arbejdsområdet, når de er tilgængelige. Udelades, når den offentlige funktion er deaktiveret, kapacitets- eller backendindstillinger ikke er tilgængelige, eller opslaget med blød sletning mislykkes. En udeladt egenskab betyder ikke, at blød sletning er deaktiveret eller ikke konfigureret. |
| immutabilityPolicies |
Indstillinger for uforanderlighed i arbejdsområdet. |
|
| lifecycle |
Indstillinger for administration af livscyklus for arbejdsområdet. Kun til stede, når livscyklusstyring er aktiveret. |
ImmutabilityPolicy
Politikobjekt for uforanderlighed.
| Navn | Type | Beskrivelse |
|---|---|---|
| retentionDays |
integer minimum: 1 |
Værdien af de konfigurerede opbevaringsdage. |
| scope |
Omfanget af uforanderlighedspolitikken. |
ImmutabilityScope
Omfanget af uforanderlighedspolitik. Der kan tilføjes flere områdetyper for uforanderlighed over tid.
| Værdi | Beskrivelse |
|---|---|
| DiagnosticLogs |
Uforanderlighedspolitik for diagnosticeringslogge. |
ItemReferenceById
En elementreference efter id-objekt.
| Navn | Type | Beskrivelse |
|---|---|---|
| itemId |
string (uuid) |
Id'et for elementet. |
| referenceType |
string:
By |
Elementreferencetypen. |
| workspaceId |
string (uuid) |
Elementets arbejdsområde-id. |
ItemReferenceByVariable
En elementreference efter variabel.
| Navn | Type | Beskrivelse |
|---|---|---|
| referenceType |
string:
By |
Elementreferencetypen. |
| variableReference |
string |
En variabelreferencestreng, der angiver variabelbiblioteket og variabelnavnet i det. Format: |
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. |
Lifecycle
Indstillinger for administration af livscyklus for arbejdsområdet. Kun til stede, når livscyklusstyring er aktiveret.
| Navn | Type | Beskrivelse |
|---|---|---|
| accessTimeTracking |
Angiver, om Azure Storage adgangstidssporing (LastAccessTime-opdateringer) er aktiveret for OneLake-filer i arbejdsområdet. |
|
| defaultTier |
Standardadgangsniveau for arbejdsområdet. Alle filer uden et eksplicit angivet niveau gemmes på standardniveauet. |
|
| policy |
Angiver, om der er mindst én aktiv livscyklusregel i arbejdsområdet. |
OneLakeAccessTier
Adgangsniveauerne OneLake. Der kan tilføjes yderligere værdier for adgangsniveauer over tid.
| Værdi | Beskrivelse |
|---|---|
| Hot |
Varmt adgangsniveau. Højeste lageromkostninger og laveste transaktionsomkostninger. |
| Cool |
Cool adgangsniveau. Lavere lageromkostninger og højere transaktionsomkostninger. Mindst 30 dages lagerplads. |
| Cold |
Koldt adgangsniveau. Laveste lageromkostninger og højeste transaktionsomkostninger. Minimum 60 dages lagerplads. |
OneLakeDiagnosticSettings
OneLake-objekt til diagnosticeringsindstillinger.
| Navn | Type | Beskrivelse |
|---|---|---|
| destination | OneLakeDiagnosticSettingsDestinationInfo: |
Den destination, hvor OneLake-diagnosticeringslogge gemmes. Hvis du deaktiverer, er dette ikke påkrævet. |
| status |
string |
Status for diagnosticeringsindstillingerne. |
OneLakeFileSoftDeleteStatus
Status for blød sletning af filen for et arbejdsområde. Der kan tilføjes yderligere statusværdier over tid.
| Værdi | Beskrivelse |
|---|---|
| Enabled |
Blød sletning af filen er aktiveret. Slettede filer bevares i den konfigurerede opbevaringsperiode før permanent sletning. |
| Disabled |
Blød sletning af filen er deaktiveret. Filer, der slettes efter deaktivering, tilsidesætter opbevaring og fjernes permanent med det samme. Filer, der allerede er i blød slettet tilstand, bevarer deres eksisterende udløb. |
OneLakeLifecyclePolicyStatus
Status for OneLake-livscykluspolitikken. Der kan tilføjes yderligere statusværdier over tid.
| Værdi | Beskrivelse |
|---|---|
| Inactive |
Der er ikke konfigureret nogen livscykluspolitikregler. |
| Active |
Politikregler for livscyklus er konfigureret og aktive. |