Udostępnij za pośrednictwem

Workspaces - Create Or Update

  • Odwołanie
Usługa:
Log Analytics
Wersja interfejsu API:
2023-09-01

Utwórz lub zaktualizuj obszar roboczy.

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
resourceGroupName
 path True

string

Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.
subscriptionId
 path True

string

Identyfikator subskrypcji docelowej.
workspaceName
 path True

string

Nazwa obszaru roboczego.

Wzorzec wyrażenia regularnego: ^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$
api-version
 query True

string

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 dla tego obszaru roboczego. Oczekiwany format to /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionRules/{dcrName}.
properties.features

WorkspaceFeatures

Funkcje obszaru roboczego.
properties.forceCmkForQuery

boolean

Wskazuje, czy magazyn zarządzany przez klienta jest obowiązkowy w przypadku 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.retentionInDays

integer

Przechowywanie danych obszaru roboczego w dniach. Dozwolone wartości są naliczane 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

Zaakceptowano
Other Status Codes

ErrorResponse

Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ 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

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"
  }
}

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, gdy wybrano jednostkę 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

Dokumentacja zasobów zakresu łącza prywatnego.
PublicNetworkAccessType

Typ dostępu do sieci do 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.
WorkspaceFeatures

Funkcje obszaru roboczego.
WorkspaceSku

Jednostka SKU (warstwa) obszaru roboczego.
WorkspaceSkuNameEnum

Nazwa jednostki SKU.

CapacityReservationLevel

Poziom rezerwacji pojemności w GB dla tego obszaru roboczego, gdy wybrano jednostkę SKU CapacityReservation.

Nazwa Typ Opis
100

Integer

1000

Integer

10000

Integer

200

Integer

2000

Integer

25000

Integer

300

Integer

400

Integer

500

Integer

5000

Integer

50000

Integer

createdByType

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

Nazwa Typ Opis
Application

string

Key

string

ManagedIdentity

string

User

string

DataIngestionStatus

Stan pozyskiwania danych dla tego obszaru roboczego.

Nazwa Typ Opis
ApproachingQuota

string

80% dziennego limitu przydziału osiągniętego.
ForceOff

string

Pozyskiwanie zatrzymało się po zmianie ustawienia usługi.
ForceOn

string

Pozyskiwanie rozpoczęto po zmianie ustawienia usługi.
OverQuota

string

Osiągnięto dzienny limit przydziału, zatrzymano pozyskiwanie.
RespectQuota

string

Pozyskiwanie jest włączone po zresetowaniu dziennego limitu przydziału lub włączeniu subskrypcji.
SubscriptionSuspended

string

Pozyskiwanie zostało zatrzymane po wstrzymanej subskrypcji.

ErrorAdditionalInfo

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

Nazwa Typ Opis
info

object

Dodatkowe informacje.
type

string

Dodatkowy typ informacji.

ErrorDetail

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

Odpowiedź na błąd

Nazwa Typ Opis
error

ErrorDetail

Obiekt error.

Identity

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 usługi ARM w postaci: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".

IdentityType

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

Nazwa Typ Opis
None

string

SystemAssigned

string

UserAssigned

string

PrivateLinkScopedResource

Dokumentacja zasobów zakresu łącza prywatnego.

Nazwa Typ Opis
resourceId

string

Pełny identyfikator zasobu zakresu łącza prywatnego.
scopeId

string

Unikatowy identyfikator zakresu łącza prywatnego.

PublicNetworkAccessType

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

Nazwa Typ Opis
Disabled

string

Wyłącza łączność publiczną z usługą Log Analytics za pośrednictwem publicznego systemu DNS.
Enabled

string

Umożliwia łączność z usługą Log Analytics za pośrednictwem publicznej usługi DNS.

systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa Typ Opis
createdAt

string

Sygnatura czasowa tworzenia zasobów (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

Sygnatura czasowa 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

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

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

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.features

WorkspaceFeatures

Funkcje obszaru roboczego.
properties.forceCmkForQuery

boolean

Wskazuje, czy magazyn zarządzany przez klienta jest obowiązkowy w przypadku zarządzania zapytaniami.
properties.modifiedDate

string

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.retentionInDays

integer

Przechowywanie danych obszaru roboczego w dniach. Dozwolone wartości są naliczane 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

Dzienny limit ilości na potrzeby pozyskiwania.

Nazwa Typ Opis
dailyQuotaGb

number

Dzienny limit przydziału obszaru roboczego na potrzeby pozyskiwania.
dataIngestionStatus

DataIngestionStatus

Stan pozyskiwania danych dla tego obszaru roboczego.
quotaNextResetTime

string

Czas spoczynku przydziału.

WorkspaceEntityStatus

Stan aprowizacji obszaru roboczego.

Nazwa Typ Opis
Canceled

string

Creating

string

Deleting

string

Failed

string

ProvisioningAccount

string

Succeeded

string

Updating

string

WorkspaceFeatures

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 uprawnienia do użycia — zasób, 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 rozliczeń usługi Sentinel.

WorkspaceSku

Jednostka SKU (warstwa) obszaru roboczego.

Nazwa Typ Opis
capacityReservationLevel

CapacityReservationLevel

Poziom rezerwacji pojemności w GB dla tego obszaru roboczego, gdy wybrano jednostkę SKU CapacityReservation.
lastSkuUpdate

string

Czas ostatniej aktualizacji jednostki SKU.
name

WorkspaceSkuNameEnum

Nazwa jednostki SKU.

WorkspaceSkuNameEnum

Nazwa jednostki SKU.

Nazwa Typ Opis
CapacityReservation

string

Free

string

LACluster

string

PerGB2018

string

PerNode

string

Premium

string

Standalone

string

Standard

string