Workspaces - Create Or Update

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

Erstellen oder Aktualisieren eines Arbeitsbereichs.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
resourceGroupName
 path True

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.
subscriptionId
 path True

string

Hierbei handelt es sich um die ID des Zielabonnements.
workspaceName
 path True

string

Den Namen des Arbeitsbereichs

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

string

Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Anforderungstext

Name Erforderlich Typ Beschreibung
location True

string

Der geografische Standort, an dem sich die Ressource befindet
etag

string

Das Etag des Arbeitsbereichs.
identity

Identity

Die Identität der Ressource.
properties.defaultDataCollectionRuleResourceId

string

Die Ressourcen-ID der Standarddatensammlungsregel, die für diesen Arbeitsbereich verwendet werden soll. Das erwartete Format lautet /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionRules/{dcrName}.
properties.features

WorkspaceFeatures

Arbeitsbereichsfeatures.
properties.forceCmkForQuery

boolean

Gibt an, ob der vom Kunden verwaltete Speicher für die Abfrageverwaltung obligatorisch ist.
properties.publicNetworkAccessForIngestion

PublicNetworkAccessType

Der Netzwerkzugriffstyp für den Zugriff auf die Log Analytics-Erfassung.
properties.publicNetworkAccessForQuery

PublicNetworkAccessType

Der Netzwerkzugriffstyp für den Zugriff auf die Log Analytics-Abfrage.
properties.retentionInDays

integer

Die Datenaufbewahrung des Arbeitsbereichs in Tagen. Zulässige Werte sind pro Preisplan. Weitere Informationen finden Sie in der Dokumentation zu Preistarifen.
properties.sku

WorkspaceSku

Die SKU des Arbeitsbereichs.
properties.workspaceCapping

WorkspaceCapping

Die tägliche Volumenobergrenze für die Erfassung.
tags

object

Ressourcentags.

Antworten

Name Typ Beschreibung
200 OK

Workspace

Ok-Antwortdefinition.
201 Created

Workspace

Antwortdefinition erstellt.
202 Accepted

Akzeptiert
Other Status Codes

ErrorResponse

Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

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

Scopes

Name Beschreibung
user_impersonation Identitätswechsel Ihres Benutzerkontos

Beispiele

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

Definitionen

Name Beschreibung
CapacityReservationLevel

Die Kapazitätsreservierungsebene in GB für diesen Arbeitsbereich, wenn Die CapacityReservation-SKU ausgewählt ist.
createdByType

Der Identitätstyp, der die Ressource erstellt hat.
DataIngestionStatus

Die status der Datenerfassung für diesen Arbeitsbereich.
ErrorAdditionalInfo

Zusätzliche Informationen zum Ressourcenverwaltungsfehler.
ErrorDetail

Die Fehlerdetails.
ErrorResponse

Fehlerantwort
Identity

Identität für die Ressource.
IdentityType

Typ der verwalteten Dienstidentität.
PrivateLinkScopedResource

Der Ressourcenverweis für den Private Link-Bereich.
PublicNetworkAccessType

Der Netzwerkzugriffstyp für den Betrieb im Log Analytics-Arbeitsbereich. Standardmäßig ist aktiviert.
systemData

Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.
UserIdentityProperties

Benutzerseitig zugewiesene Identitätseigenschaften.
Workspace

Der Ressourcencontainer der obersten Ebene des Arbeitsbereichs.
WorkspaceCapping

Die tägliche Volumenobergrenze für die Erfassung.
WorkspaceEntityStatus

Der Bereitstellungsstatus des Arbeitsbereichs.
WorkspaceFeatures

Arbeitsbereichsfeatures.
WorkspaceSku

Die SKU (Ebene) eines Arbeitsbereichs.
WorkspaceSkuNameEnum

Der Name der SKU.

CapacityReservationLevel

Die Kapazitätsreservierungsebene in GB für diesen Arbeitsbereich, wenn Die CapacityReservation-SKU ausgewählt ist.

Name Typ Beschreibung
100

Integer

1000

Integer

10000

Integer

200

Integer

2000

Integer

25000

Integer

300

Integer

400

Integer

500

Integer

5000

Integer

50000

Integer

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

Name Typ Beschreibung
Application

string

Key

string

ManagedIdentity

string

User

string

DataIngestionStatus

Die status der Datenerfassung für diesen Arbeitsbereich.

Name Typ Beschreibung
ApproachingQuota

string

80 % der täglichen Obergrenze erreicht.
ForceOff

string

Die Erfassung wurde nach der Änderung der Diensteinstellung beendet.
ForceOn

string

Die Erfassung wurde nach der Änderung der Diensteinstellung gestartet.
OverQuota

string

Tägliches Cap-Kontingent erreicht, Erfassung beendet.
RespectQuota

string

Die Erfassung wird nach der täglichen Zurücksetzung des Obergrenzenkontingents oder der Abonnementaktivierung aktiviert.
SubscriptionSuspended

string

Die Erfassung wurde nach dem angehaltenen Abonnement beendet.

ErrorAdditionalInfo

Zusätzliche Informationen zum Ressourcenverwaltungsfehler.

Name Typ Beschreibung
info

object

Zusätzliche Informationen.
type

string

Typ der zusätzlichen Informationen.

ErrorDetail

Die Fehlerdetails.

Name Typ Beschreibung
additionalInfo

ErrorAdditionalInfo[]

Die zusätzlichen Fehlerinformationen.
code

string

Der Fehlercode.
details

ErrorDetail[]

Die Fehlerdetails.
message

string

Die Fehlermeldung.
target

string

Das Fehlerziel.

ErrorResponse

Fehlerantwort

Name Typ Beschreibung
error

ErrorDetail

Das Fehlerobjekt.

Identity

Identität für die Ressource.

Name Typ Beschreibung
principalId

string

Die Prinzipal-ID der Ressourcenidentität.
tenantId

string

Die Mandanten-ID der Ressource.
type

IdentityType

Typ der verwalteten Dienstidentität.
userAssignedIdentities

<string,  UserIdentityProperties>

Die Liste der Benutzeridentitäten, die der Ressource zugeordnet sind. Bei den Referenzdaten des Benutzeridentitätswörterbuchs handelt es sich um ARM-Ressourcen-IDs in der Form : "/subscriptions/{subscriptionId}/resourceGroupGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".

IdentityType

Typ der verwalteten Dienstidentität.

Name Typ Beschreibung
None

string

SystemAssigned

string

UserAssigned

string

PrivateLinkScopedResource

Der Ressourcenverweis für den Private Link-Bereich.

Name Typ Beschreibung
resourceId

string

Die vollständige Ressourcen-ID der Private Link-Bereichsressource.
scopeId

string

Der eindeutige Bezeichner des Privaten Linkbereichs.

PublicNetworkAccessType

Der Netzwerkzugriffstyp für den Betrieb im Log Analytics-Arbeitsbereich. Standardmäßig ist aktiviert.

Name Typ Beschreibung
Disabled

string

Deaktiviert die öffentliche Konnektivität mit Log Analytics über öffentliches DNS.
Enabled

string

Ermöglicht die Konnektivität mit Log Analytics über öffentliches DNS.

systemData

Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

Name Typ Beschreibung
createdAt

string

Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy

string

Die Identität, die die Ressource erstellt hat.
createdByType

createdByType

Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt

string

Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy

string

Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType

createdByType

Der Identitätstyp, der die Ressource zuletzt geändert hat.

UserIdentityProperties

Benutzerseitig zugewiesene Identitätseigenschaften.

Name Typ Beschreibung
clientId

string

Die Client-ID der benutzerseitig zugewiesenen Identität.
principalId

string

Die Prinzipal-ID der benutzerseitig zugewiesenen Identität.

Workspace

Der Ressourcencontainer der obersten Ebene des Arbeitsbereichs.

Name Typ Standardwert Beschreibung
etag

string

Das Etag des Arbeitsbereichs.
id

string

Vollqualifizierte Ressourcen-ID für die Ressource. Beispiel: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity

Identity

Die Identität der Ressource.
location

string

Der geografische Standort, an dem sich die Ressource befindet
name

string

Der Name der Ressource
properties.createdDate

string

Erstellungsdatum des Arbeitsbereichs.
properties.customerId

string

Dies ist eine schreibgeschützte Eigenschaft. Stellt die ID dar, die dem Arbeitsbereich zugeordnet ist.
properties.defaultDataCollectionRuleResourceId

string

Die Ressourcen-ID der Standarddatensammlungsregel, die für diesen Arbeitsbereich verwendet werden soll. Das erwartete Format lautet /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionRules/{dcrName}.
properties.features

WorkspaceFeatures

Arbeitsbereichsfeatures.
properties.forceCmkForQuery

boolean

Gibt an, ob der vom Kunden verwaltete Speicher für die Abfrageverwaltung obligatorisch ist.
properties.modifiedDate

string

Änderungsdatum des Arbeitsbereichs.
properties.privateLinkScopedResources

PrivateLinkScopedResource[]

Liste der Ressourcen des Bereichs für verknüpfte private Links.
properties.provisioningState

WorkspaceEntityStatus

Der Bereitstellungsstatus des Arbeitsbereichs.
properties.publicNetworkAccessForIngestion

PublicNetworkAccessType

Enabled

Der Netzwerkzugriffstyp für den Zugriff auf die Log Analytics-Erfassung.
properties.publicNetworkAccessForQuery

PublicNetworkAccessType

Enabled

Der Netzwerkzugriffstyp für den Zugriff auf die Log Analytics-Abfrage.
properties.retentionInDays

integer

Die Datenaufbewahrung des Arbeitsbereichs in Tagen. Zulässige Werte sind pro Preisplan. Weitere Informationen finden Sie in der Dokumentation zu Preistarifen.
properties.sku

WorkspaceSku

Die SKU des Arbeitsbereichs.
properties.workspaceCapping

WorkspaceCapping

Die tägliche Volumenobergrenze für die Erfassung.
systemData

systemData

Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.
tags

object

Ressourcentags.
type

string

Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

WorkspaceCapping

Die tägliche Volumenobergrenze für die Erfassung.

Name Typ Beschreibung
dailyQuotaGb

number

Das tägliche Arbeitsbereichskontingent für die Erfassung.
dataIngestionStatus

DataIngestionStatus

Die status der Datenerfassung für diesen Arbeitsbereich.
quotaNextResetTime

string

Der Zeitpunkt, zu dem das Kontingent ruhen wird.

WorkspaceEntityStatus

Der Bereitstellungsstatus des Arbeitsbereichs.

Name Typ Beschreibung
Canceled

string

Creating

string

Deleting

string

Failed

string

ProvisioningAccount

string

Succeeded

string

Updating

string

WorkspaceFeatures

Arbeitsbereichsfeatures.

Name Typ Beschreibung
clusterResourceId

string

Dedizierte LA-Clusterressourcenid, die mit den Arbeitsbereichen verknüpft ist.
disableLocalAuth

boolean

Deaktivieren Sie die nicht AAD-basierte Authentifizierung.
enableDataExport

boolean

Flag, das angibt, ob Daten exportiert werden sollen.
enableLogAccessUsingOnlyResourcePermissions

boolean

Flag, das angibt, welche Berechtigung verwendet werden soll – Ressource oder Arbeitsbereich oder beides.
immediatePurgeDataOn30Days

boolean

Flag, das beschreibt, ob die Daten nach 30 Tagen entfernt werden sollen.
unifiedSentinelBillingOnly

boolean

Ein Hinweis, ob der angegebene Arbeitsbereich nur auf das einheitliche Abrechnungsmodell von Sentinel beschränkt ist.

WorkspaceSku

Die SKU (Ebene) eines Arbeitsbereichs.

Name Typ Beschreibung
capacityReservationLevel

CapacityReservationLevel

Die Kapazitätsreservierungsebene in GB für diesen Arbeitsbereich, wenn Die CapacityReservation-SKU ausgewählt ist.
lastSkuUpdate

string

Das letzte Mal, zu dem die sku aktualisiert wurde.
name

WorkspaceSkuNameEnum

Der Name der SKU.

WorkspaceSkuNameEnum

Der Name der SKU.

Name Typ Beschreibung
CapacityReservation

string

Free

string

LACluster

string

PerGB2018

string

PerNode

string

Premium

string

Standalone

string

Standard

string