Workspaces - Create Or Update

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

Creare o aggiornare un'area di lavoro.

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
resourceGroupName
 path True

string

Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.
subscriptionId
 path True

string

ID della sottoscrizione di destinazione.
workspaceName
 path True

string

Nome dell'area di lavoro.

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

string

Versione dell'API da usare per questa operazione.

Corpo della richiesta

Nome Necessario Tipo Descrizione
location True

string

Posizione geografica in cui vive la risorsa
etag

string

Etag dell'area di lavoro.
identity

Identity

Identità della risorsa.
properties.defaultDataCollectionRuleResourceId

string

ID risorsa della regola di raccolta dati predefinita da usare per questa area di lavoro. Il formato previsto è : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionRules/{dcrName}.
properties.features

WorkspaceFeatures

Funzionalità dell'area di lavoro.
properties.forceCmkForQuery

boolean

Indica se l'archiviazione gestita dal cliente è obbligatoria per la gestione delle query.
properties.publicNetworkAccessForIngestion

PublicNetworkAccessType

Tipo di accesso alla rete per l'accesso all'inserimento di Log Analytics.
properties.publicNetworkAccessForQuery

PublicNetworkAccessType

Tipo di accesso alla rete per l'accesso alla query di Log Analytics.
properties.retentionInDays

integer

Conservazione dei dati dell'area di lavoro in giorni. I valori consentiti sono per piano tariffario. Per informazioni dettagliate, vedere la documentazione sui piani tariffari.
properties.sku

WorkspaceSku

SKU dell'area di lavoro.
properties.workspaceCapping

WorkspaceCapping

Limite di volume giornaliero per l'inserimento.
tags

object

Tag di risorse.

Risposte

Nome Tipo Descrizione
200 OK

Workspace

Definizione di risposta OK.
201 Created

Workspace

Definizione di risposta creata.
202 Accepted

Accettato
Other Status Codes

ErrorResponse

Risposta di errore che descrive perché l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

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

Scopes

Nome Descrizione
user_impersonation rappresentare l'account utente

Esempio

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

Definizioni

Nome Descrizione
CapacityReservationLevel

Livello di prenotazione della capacità in GB per questa area di lavoro, quando viene selezionato lo SKU CapacityReservation.
createdByType

Tipo di identità che ha creato la risorsa.
DataIngestionStatus

Stato dell'inserimento dati per questa area di lavoro.
ErrorAdditionalInfo

Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorDetail

Dettagli dell'errore.
ErrorResponse

Risposta di errore
Identity

Identità per la risorsa.
IdentityType

Tipo di identità del servizio gestito.
PrivateLinkScopedResource

Informazioni di riferimento sulle risorse dell'ambito del collegamento privato.
PublicNetworkAccessType

Tipo di accesso alla rete per il funzionamento nell'area di lavoro Log Analytics. Per impostazione predefinita, è Abilitato
systemData

Metadati relativi alla creazione e all'ultima modifica della risorsa.
UserIdentityProperties

Proprietà di identità assegnate dall'utente.
Workspace

Contenitore di risorse dell'area di lavoro di primo livello.
WorkspaceCapping

Limite di volume giornaliero per l'inserimento.
WorkspaceEntityStatus

Stato di provisioning dell'area di lavoro.
WorkspaceFeatures

Funzionalità dell'area di lavoro.
WorkspaceSku

SKU (livello) di un'area di lavoro.
WorkspaceSkuNameEnum

Il nome della SKU.

CapacityReservationLevel

Livello di prenotazione della capacità in GB per questa area di lavoro, quando viene selezionato lo SKU CapacityReservation.

Nome Tipo Descrizione
100

Integer

1000

Integer

10000

Integer

200

Integer

2000

Integer

25000

Integer

300

Integer

400

Integer

500

Integer

5000

Integer

50000

Integer

createdByType

Tipo di identità che ha creato la risorsa.

Nome Tipo Descrizione
Application

string

Key

string

ManagedIdentity

string

User

string

DataIngestionStatus

Stato dell'inserimento dati per questa area di lavoro.

Nome Tipo Descrizione
ApproachingQuota

string

Raggiunto l'80% della quota limite giornaliera.
ForceOff

string

L'inserimento è stato arrestato dopo la modifica dell'impostazione del servizio.
ForceOn

string

Inserimento avviato dopo la modifica dell'impostazione del servizio.
OverQuota

string

È stata raggiunta la quota limite giornaliera, l'inserimento è stato arrestato.
RespectQuota

string

Inserimento abilitato dopo la reimpostazione giornaliera della quota limite o l'abilitazione della sottoscrizione.
SubscriptionSuspended

string

L'inserimento è stato arrestato dopo la sottoscrizione sospesa.

ErrorAdditionalInfo

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome Tipo Descrizione
info

object

Informazioni aggiuntive.
type

string

Tipo di informazioni aggiuntive.

ErrorDetail

Dettagli dell'errore.

Nome Tipo Descrizione
additionalInfo

ErrorAdditionalInfo[]

Informazioni aggiuntive sull'errore.
code

string

Codice di errore.
details

ErrorDetail[]

Dettagli dell'errore.
message

string

Messaggio di errore.
target

string

Destinazione dell'errore.

ErrorResponse

Risposta di errore

Nome Tipo Descrizione
error

ErrorDetail

Oggetto error.

Identity

Identità per la risorsa.

Nome Tipo Descrizione
principalId

string

ID principale dell'identità della risorsa.
tenantId

string

ID tenant della risorsa.
type

IdentityType

Tipo di identità del servizio gestito.
userAssignedIdentities

<string,  UserIdentityProperties>

Elenco di identità utente associate alla risorsa. I riferimenti alla chiave del dizionario identità utente saranno ID risorsa ARM nel formato :'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

IdentityType

Tipo di identità del servizio gestito.

Nome Tipo Descrizione
None

string

SystemAssigned

string

UserAssigned

string

PrivateLinkScopedResource

Informazioni di riferimento sulle risorse dell'ambito del collegamento privato.

Nome Tipo Descrizione
resourceId

string

ID completo della risorsa dell'ambito del collegamento privato.
scopeId

string

Identificatore univoco dell'ambito del collegamento privato.

PublicNetworkAccessType

Tipo di accesso alla rete per il funzionamento nell'area di lavoro Log Analytics. Per impostazione predefinita, è Abilitato

Nome Tipo Descrizione
Disabled

string

Disabilita la connettività pubblica a Log Analytics tramite DNS pubblico.
Enabled

string

Consente la connettività a Log Analytics tramite DNS pubblico.

systemData

Metadati relativi alla creazione e all'ultima modifica della risorsa.

Nome Tipo Descrizione
createdAt

string

Timestamp della creazione di risorse (UTC).
createdBy

string

Identità che ha creato la risorsa.
createdByType

createdByType

Tipo di identità che ha creato la risorsa.
lastModifiedAt

string

Timestamp dell'ultima modifica della risorsa (UTC)
lastModifiedBy

string

Identità che ha modificato l'ultima volta la risorsa.
lastModifiedByType

createdByType

Tipo di identità che ha modificato l'ultima volta la risorsa.

UserIdentityProperties

Proprietà di identità assegnate dall'utente.

Nome Tipo Descrizione
clientId

string

ID client dell'identità assegnata dall'utente.
principalId

string

ID principale dell'identità assegnata dall'utente.

Workspace

Contenitore di risorse dell'area di lavoro di primo livello.

Nome Tipo Valore predefinito Descrizione
etag

string

Etag dell'area di lavoro.
id

string

ID di risorsa completo per la risorsa. Ad esempio - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity

Identity

Identità della risorsa.
location

string

Posizione geografica in cui risiede la risorsa
name

string

nome della risorsa.
properties.createdDate

string

Data di creazione dell'area di lavoro.
properties.customerId

string

Questa proprietà è di sola lettura. Rappresenta l'ID associato all'area di lavoro.
properties.defaultDataCollectionRuleResourceId

string

ID risorsa della regola di raccolta dati predefinita da usare per questa area di lavoro. Il formato previsto è : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionRules/{dcrName}.
properties.features

WorkspaceFeatures

Funzionalità dell'area di lavoro.
properties.forceCmkForQuery

boolean

Indica se l'archiviazione gestita dal cliente è obbligatoria per la gestione delle query.
properties.modifiedDate

string

Data di modifica dell'area di lavoro.
properties.privateLinkScopedResources

PrivateLinkScopedResource[]

Elenco delle risorse dell'ambito del collegamento privato collegato.
properties.provisioningState

WorkspaceEntityStatus

Stato di provisioning dell'area di lavoro.
properties.publicNetworkAccessForIngestion

PublicNetworkAccessType

Enabled

Tipo di accesso alla rete per l'accesso all'inserimento di Log Analytics.
properties.publicNetworkAccessForQuery

PublicNetworkAccessType

Enabled

Tipo di accesso alla rete per l'accesso alla query di Log Analytics.
properties.retentionInDays

integer

Conservazione dei dati dell'area di lavoro in giorni. I valori consentiti sono per piano tariffario. Per informazioni dettagliate, vedere la documentazione sui piani tariffari.
properties.sku

WorkspaceSku

SKU dell'area di lavoro.
properties.workspaceCapping

WorkspaceCapping

Limite di volume giornaliero per l'inserimento.
systemData

systemData

Metadati relativi alla creazione e all'ultima modifica della risorsa.
tags

object

Tag delle risorse.
type

string

Tipo di risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

WorkspaceCapping

Limite di volume giornaliero per l'inserimento.

Nome Tipo Descrizione
dailyQuotaGb

number

Quota giornaliera dell'area di lavoro per l'inserimento.
dataIngestionStatus

DataIngestionStatus

Stato dell'inserimento dati per questa area di lavoro.
quotaNextResetTime

string

Ora di riposo della quota.

WorkspaceEntityStatus

Stato di provisioning dell'area di lavoro.

Nome Tipo Descrizione
Canceled

string

Creating

string

Deleting

string

Failed

string

ProvisioningAccount

string

Succeeded

string

Updating

string

WorkspaceFeatures

Funzionalità dell'area di lavoro.

Nome Tipo Descrizione
clusterResourceId

string

ResourceId cluster LA dedicato collegato alle aree di lavoro.
disableLocalAuth

boolean

Disabilitare l'autenticazione non basata su AAD.
enableDataExport

boolean

Flag che indica se i dati devono essere esportati.
enableLogAccessUsingOnlyResourcePermissions

boolean

Flag che indica l'autorizzazione da usare: risorsa o area di lavoro o entrambe.
immediatePurgeDataOn30Days

boolean

Flag che descrive se si vogliono rimuovere i dati dopo 30 giorni.
unifiedSentinelBillingOnly

boolean

Indicazione se l'area di lavoro specifica è limitata solo al modello di fatturazione unificato di Sentinel.

WorkspaceSku

SKU (livello) di un'area di lavoro.

Nome Tipo Descrizione
capacityReservationLevel

CapacityReservationLevel

Livello di prenotazione della capacità in GB per questa area di lavoro, quando viene selezionato lo SKU CapacityReservation.
lastSkuUpdate

string

Ora dell'ultimo aggiornamento dello SKU.
name

WorkspaceSkuNameEnum

Il nome della SKU.

WorkspaceSkuNameEnum

Il nome della SKU.

Nome Tipo Descrizione
CapacityReservation

string

Free

string

LACluster

string

PerGB2018

string

PerNode

string

Premium

string

Standalone

string

Standard

string