Workspaces - Create Or Update

Odwołanie

Usługa:: Log Analytics

Wersja interfejsu API:: 2025-02-01

Tworzenie lub aktualizowanie obszaru roboczego.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
subscriptionId	path	True	string minLength: 1	Identyfikator subskrypcji docelowej.
workspaceName	path	True	string minLength: 4 maxLength: 63 pattern: ^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$	Nazwa obszaru roboczego.
api-version	query	True	string minLength: 1	Wersja interfejsu API do użycia dla tej operacji.

Treść żądania

Nazwa	Wymagane	Typ	Opis
location	True	string	Lokalizacja geograficzna, w której znajduje się zasób
etag		string	Element etag obszaru roboczego.
identity		Identity	Tożsamość zasobu.
properties.defaultDataCollectionRuleResourceId		string	Identyfikator zasobu domyślnej reguły zbierania danych do użycia w tym obszarze roboczym. Oczekiwany format to /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionRules/{dcrName}.
properties.failover		WorkspaceFailoverProperties	właściwości trybu failover obszaru roboczego.
properties.features		WorkspaceFeatures	Funkcje obszaru roboczego.
properties.forceCmkForQuery		boolean	Wskazuje, czy magazyn zarządzany przez klienta jest obowiązkowy do zarządzania zapytaniami.
properties.publicNetworkAccessForIngestion		PublicNetworkAccessType	Typ dostępu do sieci na potrzeby uzyskiwania dostępu do pozyskiwania usługi Log Analytics.
properties.publicNetworkAccessForQuery		PublicNetworkAccessType	Typ dostępu do sieci na potrzeby uzyskiwania dostępu do zapytania usługi Log Analytics.
properties.replication		WorkspaceReplicationProperties	właściwości replikacji obszaru roboczego.
properties.retentionInDays		integer (int32)	Przechowywanie danych obszaru roboczego w dniach. Dozwolone wartości są według planu cenowego. Aby uzyskać szczegółowe informacje, zobacz dokumentację warstw cenowych.
properties.sku		WorkspaceSku	Jednostka SKU obszaru roboczego.
properties.workspaceCapping		WorkspaceCapping	Dzienny limit ilości na potrzeby pozyskiwania.
tags		object	Tagi zasobów.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	Workspace	Definicja odpowiedzi OK.
201 Created	Workspace	Utworzono definicję odpowiedzi.
202 Accepted		Akceptowane
Other Status Codes	ErrorResponse	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ protokołu OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

WorkspacesCreate

Przykładowe żądanie

HTTP

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

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

Przykładowa odpowiedź

Kod stanu:: 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"
  }
}

Kod stanu:: 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"
  }
}

Kod stanu:: 202

Definicje

Nazwa	Opis
CapacityReservationLevel	Poziom rezerwacji pojemności w GB dla tego obszaru roboczego po wybraniu jednostki SKU CapacityReservation.
createdByType	Typ tożsamości, która utworzyła zasób.
DataIngestionStatus	Stan pozyskiwania danych dla tego obszaru roboczego.
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
Identity	Tożsamość zasobu.
IdentityType	Typ tożsamości usługi zarządzanej.
PrivateLinkScopedResource	Odwołanie do zasobu zakresu łącza prywatnego.
PublicNetworkAccessType	Typ dostępu do sieci dla działania w obszarze roboczym usługi Log Analytics. Domyślnie jest włączona
systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.
UserIdentityProperties	Właściwości tożsamości przypisanej przez użytkownika.
Workspace	Kontener zasobów obszaru roboczego najwyższego poziomu.
WorkspaceCapping	Dzienny limit ilości na potrzeby pozyskiwania.
WorkspaceEntityStatus	Stan aprowizacji obszaru roboczego.
WorkspaceFailoverProperties	Stan trybu failover replikacji.
WorkspaceFailoverState	Stan trybu failover replikacji.
WorkspaceFeatures	Funkcje obszaru roboczego.
WorkspaceReplicationProperties	Właściwości replikacji obszaru roboczego.
WorkspaceReplicationState	Stan aprowizacji replikacji.
WorkspaceSku	Jednostka SKU (warstwa) obszaru roboczego.
WorkspaceSkuNameEnum	Nazwa jednostki SKU.

CapacityReservationLevel

Wyliczanie

Poziom rezerwacji pojemności w GB dla tego obszaru roboczego po wybraniu jednostki SKU CapacityReservation.

Wartość	Opis
100
1000
10000
200
2000
25000
300
400
500
5000
50000

createdByType

Wyliczanie

Typ tożsamości, która utworzyła zasób.

Wartość	Opis
Application
Key
ManagedIdentity
User

DataIngestionStatus

Wyliczanie

Stan pozyskiwania danych dla tego obszaru roboczego.

Wartość	Opis
ApproachingQuota	Osiągnięto 80% dziennego limitu przydziału.
ForceOff	Pozyskiwanie zatrzymało się po zmianie ustawienia usługi.
ForceOn	Pozyskiwanie rozpoczęto po zmianie ustawienia usługi.
OverQuota	Osiągnięto dzienny limit przydziału, pozyskiwanie zatrzymano.
RespectQuota	Pozyskiwanie jest włączone po zresetowaniu dziennego limitu przydziału lub włączeniu subskrypcji.
SubscriptionSuspended	Pozyskiwanie zostało zatrzymane po zawieszonej subskrypcji.

ErrorAdditionalInfo

Objekt

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorDetail

Objekt

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorDetail[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorResponse

Objekt

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt błędu.

Identity

Objekt

Tożsamość zasobu.

Nazwa	Typ	Opis
principalId	string	Identyfikator podmiotu zabezpieczeń tożsamości zasobu.
tenantId	string	Identyfikator dzierżawy zasobu.
type	IdentityType	Typ tożsamości usługi zarządzanej.
userAssignedIdentities	<string, UserIdentityProperties>	Lista tożsamości użytkowników skojarzonych z zasobem. Odwołania do klucza słownika tożsamości użytkownika będą identyfikatorami zasobów arm w postaci: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".

IdentityType

Wyliczanie

Typ tożsamości usługi zarządzanej.

Wartość	Opis
None
SystemAssigned
UserAssigned

PrivateLinkScopedResource

Objekt

Odwołanie do zasobu zakresu łącza prywatnego.

Nazwa	Typ	Opis
resourceId	string	Pełny identyfikator zasobu zakresu łącza prywatnego.
scopeId	string	Unikatowy identyfikator zakresu łącza prywatnego.

PublicNetworkAccessType

Wyliczanie

Typ dostępu do sieci dla działania w obszarze roboczym usługi Log Analytics. Domyślnie jest włączona

Wartość	Opis
Disabled	Wyłącza łączność publiczną z usługą Log Analytics za pośrednictwem publicznego systemu DNS.
Enabled	Umożliwia łączność z usługą Log Analytics za pośrednictwem publicznego systemu DNS.

systemData

Objekt

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa	Typ	Opis
createdAt	string (date-time)	Sygnatura czasowa tworzenia zasobu (UTC).
createdBy	string	Tożsamość, która utworzyła zasób.
createdByType	createdByType	Typ tożsamości, która utworzyła zasób.
lastModifiedAt	string (date-time)	Znacznik czasu ostatniej modyfikacji zasobu (UTC)
lastModifiedBy	string	Tożsamość, która ostatnio zmodyfikowała zasób.
lastModifiedByType	createdByType	Typ tożsamości, która ostatnio zmodyfikowała zasób.

UserIdentityProperties

Objekt

Właściwości tożsamości przypisanej przez użytkownika.

Nazwa	Typ	Opis
clientId	string	Identyfikator klienta tożsamości przypisanej przez użytkownika.
principalId	string	Identyfikator podmiotu zabezpieczeń tożsamości przypisanej przez użytkownika.

Workspace

Objekt

Kontener zasobów obszaru roboczego najwyższego poziomu.

Nazwa	Typ	Domyślna wartość	Opis
etag	string		Element etag obszaru roboczego.
id	string		W pełni kwalifikowany identyfikator zasobu dla zasobu. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	Identity		Tożsamość zasobu.
location	string		Lokalizacja geograficzna, w której znajduje się zasób
name	string		Nazwa zasobu
properties.createdDate	string (date-time)		Data utworzenia obszaru roboczego.
properties.customerId	string		Jest to właściwość tylko do odczytu. Reprezentuje identyfikator skojarzony z obszarem roboczym.
properties.defaultDataCollectionRuleResourceId	string		Identyfikator zasobu domyślnej reguły zbierania danych do użycia w tym obszarze roboczym. Oczekiwany format to /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionRules/{dcrName}.
properties.failover	WorkspaceFailoverProperties		właściwości trybu failover obszaru roboczego.
properties.features	WorkspaceFeatures		Funkcje obszaru roboczego.
properties.forceCmkForQuery	boolean		Wskazuje, czy magazyn zarządzany przez klienta jest obowiązkowy do zarządzania zapytaniami.
properties.modifiedDate	string (date-time)		Data modyfikacji obszaru roboczego.
properties.privateLinkScopedResources	PrivateLinkScopedResource[]		Lista połączonych zasobów zakresu łącza prywatnego.
properties.provisioningState	WorkspaceEntityStatus		Stan aprowizacji obszaru roboczego.
properties.publicNetworkAccessForIngestion	PublicNetworkAccessType	Enabled	Typ dostępu do sieci na potrzeby uzyskiwania dostępu do pozyskiwania usługi Log Analytics.
properties.publicNetworkAccessForQuery	PublicNetworkAccessType	Enabled	Typ dostępu do sieci na potrzeby uzyskiwania dostępu do zapytania usługi Log Analytics.
properties.replication	WorkspaceReplicationProperties		właściwości replikacji obszaru roboczego.
properties.retentionInDays	integer (int32)		Przechowywanie danych obszaru roboczego w dniach. Dozwolone wartości są według planu cenowego. Aby uzyskać szczegółowe informacje, zobacz dokumentację warstw cenowych.
properties.sku	WorkspaceSku		Jednostka SKU obszaru roboczego.
properties.workspaceCapping	WorkspaceCapping		Dzienny limit ilości na potrzeby pozyskiwania.
systemData	systemData		Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.
tags	object		Tagi zasobów.
type	string		Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

WorkspaceCapping

Objekt

Dzienny limit ilości na potrzeby pozyskiwania.

Nazwa	Typ	Opis
dailyQuotaGb	number (double)	Dzienny limit przydziału obszaru roboczego na potrzeby pozyskiwania.
dataIngestionStatus	DataIngestionStatus	Stan pozyskiwania danych dla tego obszaru roboczego.
quotaNextResetTime	string	Czas odpoczynku przydziału.

WorkspaceEntityStatus

Wyliczanie

Stan aprowizacji obszaru roboczego.

Wartość	Opis
Canceled
Creating
Deleting
Failed
ProvisioningAccount
Succeeded
Updating

WorkspaceFailoverProperties

Objekt

Stan trybu failover replikacji.

Nazwa	Typ	Opis
lastModifiedDate	string (date-time)	Czas ostatniej aktualizacji stanu trybu failover.
state	WorkspaceFailoverState	Stan trybu failover replikacji.

WorkspaceFailoverState

Wyliczanie

Stan trybu failover replikacji.

Wartość	Opis
Activating
Active
Deactivating
Failed
Inactive

WorkspaceFeatures

Objekt

Funkcje obszaru roboczego.

Nazwa	Typ	Opis
clusterResourceId	string	Dedykowany identyfikator resourceId klastra la połączony z obszarami roboczymi.
disableLocalAuth	boolean	Wyłącz uwierzytelnianie oparte na usłudze AAD.
enableDataExport	boolean	Flaga wskazująca, czy dane mają być eksportowane.
enableLogAccessUsingOnlyResourcePermissions	boolean	Flaga wskazująca, które uprawnienie do użycia — zasób lub obszar roboczy lub oba te elementy.
immediatePurgeDataOn30Days	boolean	Flaga opisując, czy chcemy usunąć dane po 30 dniach.
unifiedSentinelBillingOnly	boolean	Wskazanie, czy określony obszar roboczy jest ograniczony tylko do ujednoliconego modelu rozliczeniowego usługi Sentinel.

WorkspaceReplicationProperties

Objekt

Właściwości replikacji obszaru roboczego.

Nazwa	Typ	Opis
createdDate	string (date-time)	Czas ostatniej włączenia replikacji.
enabled	boolean	Określa, czy replikacja jest włączona, czy nie. W przypadku wartości true konfiguracja i dane obszaru roboczego są replikowane do określonej lokalizacji. Jeśli włączono replikację, należy podać lokalizację.
lastModifiedDate	string (date-time)	Czas ostatniej aktualizacji replikacji.
location	string	Lokalizacja replikacji.
provisioningState	WorkspaceReplicationState	Stan aprowizacji replikacji.

WorkspaceReplicationState

Wyliczanie

Stan aprowizacji replikacji.

Wartość	Opis
Canceled
DisableRequested
Disabling
EnableRequested
Enabling
Failed
RollbackRequested
RollingBack
Succeeded

WorkspaceSku

Objekt

Jednostka SKU (warstwa) obszaru roboczego.

Nazwa	Typ	Opis
capacityReservationLevel	CapacityReservationLevel (int32)	Poziom rezerwacji pojemności w GB dla tego obszaru roboczego po wybraniu jednostki SKU CapacityReservation.
lastSkuUpdate	string (date-time)	Czas ostatniej aktualizacji jednostki SKU.
name	WorkspaceSkuNameEnum	Nazwa jednostki SKU.

WorkspaceSkuNameEnum

Wyliczanie

Nazwa jednostki SKU.

Wartość	Opis
CapacityReservation
Free
LACluster
PerGB2018
PerNode
Premium
Standalone
Standard

Udostępnij za pośrednictwem

Workspaces - Create Or Update

Parametry identyfikatora URI

Treść żądania

Odpowiedzi

Zabezpieczenia

azure_auth

Zakresy

Przykłady

WorkspacesCreate

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

CapacityReservationLevel

createdByType

DataIngestionStatus

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

Identity

IdentityType

PrivateLinkScopedResource

PublicNetworkAccessType

systemData

UserIdentityProperties

Workspace

WorkspaceCapping

WorkspaceEntityStatus

WorkspaceFailoverProperties

WorkspaceFailoverState

WorkspaceFeatures

WorkspaceReplicationProperties

WorkspaceReplicationState

WorkspaceSku

WorkspaceSkuNameEnum

Dodatkowe zasoby