Workspaces - Create Or Update

  • Referens
Service:
Log Analytics
API Version:
2023-09-01

Skapa eller uppdatera en arbetsyta.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}?api-version=2023-09-01

URI-parametrar

Name I Obligatorisk Typ Description
resourceGroupName
 path True

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
subscriptionId
 path True

string

ID för målprenumerationen.
workspaceName
 path True

string

Namnet på arbetsytan.

Regex pattern: ^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$
api-version
 query True

string

Den API-version som ska användas för den här åtgärden.

Begärandetext

Name Obligatorisk Typ Description
location True

string

Den geo-plats där resursen finns
etag

string

Etag för arbetsytan.
identity

Identity

Resursens identitet.
properties.defaultDataCollectionRuleResourceId

string

Resurs-ID för standardregeln för datainsamling som ska användas för den här arbetsytan. Förväntat format är – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionRules/{dcrName}.
properties.features

WorkspaceFeatures

Arbetsytefunktioner.
properties.forceCmkForQuery

boolean

Anger om kundhanterad lagring är obligatorisk för frågehantering.
properties.publicNetworkAccessForIngestion

PublicNetworkAccessType

Nätverksåtkomsttypen för åtkomst till Log Analytics-inmatning.
properties.publicNetworkAccessForQuery

PublicNetworkAccessType

Nätverksåtkomsttypen för åtkomst till Log Analytics-fråga.
properties.retentionInDays

integer

Datakvarhållningen för arbetsytan i dagar. Tillåtna värden är per prisplan. Mer information finns i dokumentationen om prisnivåer.
properties.sku

WorkspaceSku

SKU:n för arbetsytan.
properties.workspaceCapping

WorkspaceCapping

Det dagliga volymtaket för inmatning.
tags

object

Resurstaggar.

Svar

Name Typ Description
200 OK

Workspace

OK svarsdefinition.
201 Created

Workspace

Svarsdefinition har skapats.
202 Accepted

Har godkänts
Other Status Codes

ErrorResponse

Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation personifiera ditt användarkonto

Exempel

WorkspacesCreate

Sample Request

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-00000000000/resourcegroups/oiautorest6685/providers/Microsoft.OperationalInsights/workspaces/oiautorest6685?api-version=2023-09-01

{
  "properties": {
    "sku": {
      "name": "PerGB2018"
    },
    "retentionInDays": 30
  },
  "location": "australiasoutheast",
  "tags": {
    "tag1": "val1"
  }
}

Sample Response

Status code:
200 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourcegroups/oiautorest6685/providers/microsoft.operationalinsights/workspaces/aztest2170",
  "name": "AzTest2170",
  "type": "Microsoft.OperationalInsights/workspaces",
  "location": "australiasoutheast",
  "tags": {
    "tag1": "val1"
  },
  "properties": {
    "customerId": "bc089d7b-485c-4aff-a71e-c00f362d8d2f",
    "provisioningState": "Creating",
    "sku": {
      "name": "PerGB2018"
    },
    "retentionInDays": 30,
    "publicNetworkAccessForQuery": "Enabled",
    "publicNetworkAccessForIngestion": "Enabled"
  }
}
Status code:
201 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourcegroups/oiautorest6685/providers/microsoft.operationalinsights/workspaces/aztest2170",
  "name": "AzTest2170",
  "type": "Microsoft.OperationalInsights/workspaces",
  "location": "australiasoutheast",
  "tags": {
    "tag1": "val1"
  },
  "properties": {
    "customerId": "bc089d7b-485c-4aff-a71e-c00f362d8d2f",
    "provisioningState": "Creating",
    "sku": {
      "name": "PerGB2018"
    },
    "retentionInDays": 30,
    "publicNetworkAccessForQuery": "Enabled",
    "publicNetworkAccessForIngestion": "Enabled"
  }
}
Status code:
202

Definitioner

Name Description
CapacityReservationLevel

Kapacitetsreservationsnivån i GB för den här arbetsytan när CapacityReservation sku väljs.
createdByType

Den typ av identitet som skapade resursen.
DataIngestionStatus

Status för datainmatning för den här arbetsytan.
ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.
ErrorDetail

Felinformationen.
ErrorResponse

Felsvar
Identity

Identitet för resursen.
IdentityType

Typ av hanterad tjänstidentitet.
PrivateLinkScopedResource

Resursreferensen för omfånget privat länk.
PublicNetworkAccessType

Nätverksåtkomsttypen för att arbeta på Log Analytics-arbetsytan. Som standard är den Aktiverad
systemData

Metadata som rör skapande och senaste ändring av resursen.
UserIdentityProperties

Användartilldelade identitetsegenskaper.
Workspace

Resurscontainern för arbetsytans översta nivå.
WorkspaceCapping

Det dagliga volymtaket för inmatning.
WorkspaceEntityStatus

Etableringstillståndet för arbetsytan.
WorkspaceFeatures

Arbetsytefunktioner.
WorkspaceSku

SKU:n (nivån) för en arbetsyta.
WorkspaceSkuNameEnum

Namnet på SKU:n.

CapacityReservationLevel

Kapacitetsreservationsnivån i GB för den här arbetsytan när CapacityReservation sku väljs.

Name Typ Description
100

Integer

1000

Integer

10000

Integer

200

Integer

2000

Integer

25000

Integer

300

Integer

400

Integer

500

Integer

5000

Integer

50000

Integer

createdByType

Den typ av identitet som skapade resursen.

Name Typ Description
Application

string

Key

string

ManagedIdentity

string

User

string

DataIngestionStatus

Status för datainmatning för den här arbetsytan.

Name Typ Description
ApproachingQuota

string

80 % av den dagliga gränskvoten har nåtts.
ForceOff

string

Inmatningen stoppades efter ändring av tjänstinställningen.
ForceOn

string

Inmatningen började efter ändringen av tjänstinställningen.
OverQuota

string

Den dagliga gränskvoten har nåtts, inmatningen har stoppats.
RespectQuota

string

Inmatning aktiverad efter daglig kvotåterställning eller prenumerationsaktivering.
SubscriptionSuspended

string

Inmatningen stoppades efter en inaktiverad prenumeration.

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

Name Typ Description
info

object

Den ytterligare informationen.
type

string

Ytterligare informationstyp.

ErrorDetail

Felinformationen.

Name Typ Description
additionalInfo

ErrorAdditionalInfo[]

Ytterligare information om felet.
code

string

Felkoden.
details

ErrorDetail[]

Felinformationen.
message

string

Felmeddelandet.
target

string

Felmålet.

ErrorResponse

Felsvar

Name Typ Description
error

ErrorDetail

Felobjektet.

Identity

Identitet för resursen.

Name Typ Description
principalId

string

Huvud-ID för resursidentitet.
tenantId

string

Klientorganisations-ID för resursen.
type

IdentityType

Typ av hanterad tjänstidentitet.
userAssignedIdentities

<string,  UserIdentityProperties>

Listan över användaridentiteter som är associerade med resursen. Nyckelreferenserna för användaridentitetsordlistan är ARM-resurs-ID:er i formatet: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

IdentityType

Typ av hanterad tjänstidentitet.

Name Typ Description
None

string

SystemAssigned

string

UserAssigned

string

PrivateLinkScopedResource

Resursreferensen för omfånget privat länk.

Name Typ Description
resourceId

string

Det fullständiga resurs-ID:t för den privata länkomfångsresursen.
scopeId

string

Unik identifierare för det privata länkomfånget.

PublicNetworkAccessType

Nätverksåtkomsttypen för att arbeta på Log Analytics-arbetsytan. Som standard är den Aktiverad

Name Typ Description
Disabled

string

Inaktiverar offentlig anslutning till Log Analytics via offentlig DNS.
Enabled

string

Möjliggör anslutning till Log Analytics via offentlig DNS.

systemData

Metadata som rör skapande och senaste ändring av resursen.

Name Typ Description
createdAt

string

Tidsstämpeln för resursskapande (UTC).
createdBy

string

Identiteten som skapade resursen.
createdByType

createdByType

Den typ av identitet som skapade resursen.
lastModifiedAt

string

Tidsstämpeln för resursens senaste ändring (UTC)
lastModifiedBy

string

Identiteten som senast ändrade resursen.
lastModifiedByType

createdByType

Den typ av identitet som senast ändrade resursen.

UserIdentityProperties

Användartilldelade identitetsegenskaper.

Name Typ Description
clientId

string

Klient-ID för användartilldelad identitet.
principalId

string

Huvud-ID för användartilldelad identitet.

Workspace

Resurscontainern för arbetsytans översta nivå.

Name Typ Standardvärde Description
etag

string

Etag för arbetsytan.
id

string

Fullständigt kvalificerat resurs-ID för resursen. Exempel – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity

Identity

Resursens identitet.
location

string

Den geo-plats där resursen finns
name

string

Namnet på resursen
properties.createdDate

string

Skapandedatum för arbetsyta.
properties.customerId

string

Det här är en skrivskyddad egenskap. Representerar det ID som är associerat med arbetsytan.
properties.defaultDataCollectionRuleResourceId

string

Resurs-ID för standardregeln för datainsamling som ska användas för den här arbetsytan. Förväntat format är – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionRules/{dcrName}.
properties.features

WorkspaceFeatures

Arbetsytefunktioner.
properties.forceCmkForQuery

boolean

Anger om kundhanterad lagring är obligatorisk för frågehantering.
properties.modifiedDate

string

Ändringsdatum för arbetsyta.
properties.privateLinkScopedResources

PrivateLinkScopedResource[]

Lista över resurser för omfång för länkad privat länk.
properties.provisioningState

WorkspaceEntityStatus

Etableringstillståndet för arbetsytan.
properties.publicNetworkAccessForIngestion

PublicNetworkAccessType

Enabled

Nätverksåtkomsttypen för åtkomst till Log Analytics-inmatning.
properties.publicNetworkAccessForQuery

PublicNetworkAccessType

Enabled

Nätverksåtkomsttypen för åtkomst till Log Analytics-fråga.
properties.retentionInDays

integer

Datakvarhållningen för arbetsytan i dagar. Tillåtna värden är per prisplan. Mer information finns i dokumentationen om prisnivåer.
properties.sku

WorkspaceSku

SKU:n för arbetsytan.
properties.workspaceCapping

WorkspaceCapping

Det dagliga volymtaket för inmatning.
systemData

systemData

Metadata som rör skapande och senaste ändring av resursen.
tags

object

Resurstaggar.
type

string

Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

WorkspaceCapping

Det dagliga volymtaket för inmatning.

Name Typ Description
dailyQuotaGb

number

Arbetsytans dagliga kvot för inmatning.
dataIngestionStatus

DataIngestionStatus

Status för datainmatning för den här arbetsytan.
quotaNextResetTime

string

Den tid då kvoten kommer att vara vilande.

WorkspaceEntityStatus

Etableringstillståndet för arbetsytan.

Name Typ Description
Canceled

string

Creating

string

Deleting

string

Failed

string

ProvisioningAccount

string

Succeeded

string

Updating

string

WorkspaceFeatures

Arbetsytefunktioner.

Name Typ Description
clusterResourceId

string

Resurs-ID för dedikerade LA-kluster som är länkat till arbetsytorna.
disableLocalAuth

boolean

Inaktivera icke-AAD-baserad autentisering.
enableDataExport

boolean

Flagga som anger om data ska exporteras.
enableLogAccessUsingOnlyResourcePermissions

boolean

Flagga som anger vilken behörighet som ska användas – resurs, arbetsyta eller både och.
immediatePurgeDataOn30Days

boolean

Flagga som beskriver om vi vill ta bort data efter 30 dagar.
unifiedSentinelBillingOnly

boolean

En indikation om den angiven arbetsytan endast är begränsad till sentinels enhetliga faktureringsmodell.

WorkspaceSku

SKU:n (nivån) för en arbetsyta.

Name Typ Description
capacityReservationLevel

CapacityReservationLevel

Kapacitetsreservationsnivån i GB för den här arbetsytan när CapacityReservation sku väljs.
lastSkuUpdate

string

Senaste gången sku:n uppdaterades.
name

WorkspaceSkuNameEnum

Namnet på SKU:n.

WorkspaceSkuNameEnum

Namnet på SKU:n.

Name Typ Description
CapacityReservation

string

Free

string

LACluster

string

PerGB2018

string

PerNode

string

Premium

string

Standalone

string

Standard

string