Workspaces - List

Service:

Log Analytics

API Version:

2023-09-01

Abonelikteki çalışma alanlarını alır.

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
subscriptionId	path	True	string	Hedef aboneliğin kimliği.
api-version	query	True	string	Bu işlem için kullanılacak API sürümü.

Yanıtlar

Name	Tür	Description
200 OK	WorkspaceListResult	Tamam yanıt tanımı.
Other Status Codes	ErrorResponse	İşlemin neden başarısız olduğunu açıklayan hata yanıtı.

Güvenlik

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	kullanıcı hesabınızın kimliğine bürünme

Örnekler

WorkspacesSubscriptionList

Sample Request

HTTP

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

Sample Response

Status code:

200

{
  "value": [
    {
      "properties": {
        "customerId": "bc089d7b-485c-4aff-a71e-c00f362d8d2f",
        "provisioningState": "Succeeded",
        "sku": {
          "name": "PerGB2018"
        },
        "retentionInDays": 30,
        "publicNetworkAccessForQuery": "Enabled",
        "publicNetworkAccessForIngestion": "Enabled"
      },
      "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"
      }
    }
  ]
}

Tanımlar

Name	Description
CapacityReservationLevel	CapacityReservation sku'su seçildiğinde bu çalışma alanının GB olarak kapasite rezervasyon düzeyi.
createdByType	Kaynağı oluşturan kimliğin türü.
DataIngestionStatus	Bu çalışma alanı için veri alımının durumu.
ErrorAdditionalInfo	Kaynak yönetimi hatası ek bilgileri.
ErrorDetail	Hata ayrıntısı.
ErrorResponse	Hata yanıtı
Identity	Kaynağın kimliği.
IdentityType	Yönetilen hizmet kimliğinin türü.
PrivateLinkScopedResource	Özel bağlantı kapsamı kaynak başvurusu.
PublicNetworkAccessType	Log Analytics Çalışma Alanı'nda çalışmaya yönelik ağ erişim türü. Varsayılan olarak Etkin'dir
systemData	Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.
UserIdentityProperties	Kullanıcı tarafından atanan kimlik özellikleri.
Workspace	En üst düzey Çalışma Alanı kaynak kapsayıcısı.
WorkspaceCapping	Alım için günlük hacim sınırı.
WorkspaceEntityStatus	Çalışma alanının sağlama durumu.
WorkspaceFeatures	Çalışma alanı özellikleri.
WorkspaceListResult	Liste çalışma alanları işlem yanıtı.
WorkspaceSku	Çalışma alanının SKU'su (katman).
WorkspaceSkuNameEnum	SKU'nun adı.

CapacityReservationLevel

CapacityReservation sku'su seçildiğinde bu çalışma alanının GB olarak kapasite rezervasyon düzeyi.

Name	Tür	Description
100	Integer
1000	Integer
10000	Integer
200	Integer
2000	Integer
25000	Integer
300	Integer
400	Integer
500	Integer
5000	Integer
50000	Integer

createdByType

Kaynağı oluşturan kimliğin türü.

Name	Tür	Description
Application	string
Key	string
ManagedIdentity	string
User	string

DataIngestionStatus

Bu çalışma alanı için veri alımının durumu.

Name	Tür	Description
ApproachingQuota	string	Günlük sınır kotasının %80'ine ulaşıldı.
ForceOff	string	Hizmet ayarı değişikliği sonrasında alım durduruldu.
ForceOn	string	Hizmet ayarı değişikliğinin ardından alım başlatıldı.
OverQuota	string	Günlük sınır kotası ulaştı, alım durduruldu.
RespectQuota	string	Günlük sınır kotası sıfırlama veya abonelik etkinleştirme sonrasında alım etkinleştirildi.
SubscriptionSuspended	string	Askıya alınan aboneliğin ardından alım durduruldu.

ErrorAdditionalInfo

Kaynak yönetimi hatası ek bilgileri.

Name	Tür	Description
info	object	Ek bilgiler.
type	string	Ek bilgi türü.

ErrorDetail

Hata ayrıntısı.

Name	Tür	Description
additionalInfo	ErrorAdditionalInfo[]	Hata ek bilgileri.
code	string	Hata kodu.
details	ErrorDetail[]	Hata ayrıntıları.
message	string	Hata iletisi.
target	string	Hata hedefi.

ErrorResponse

Hata yanıtı

Name	Tür	Description
error	ErrorDetail	Hata nesnesi.

Identity

Kaynağın kimliği.

Name	Tür	Description
principalId	string	Kaynak kimliğinin asıl kimliği.
tenantId	string	Kaynağın kiracı kimliği.
type	IdentityType	Yönetilen hizmet kimliğinin türü.
userAssignedIdentities	<string,  UserIdentityProperties>	Kaynakla ilişkilendirilmiş kullanıcı kimliklerinin listesi. Kullanıcı kimliği sözlüğü anahtar başvuruları şu biçimde ARM kaynak kimlikleri olacaktır: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

IdentityType

Yönetilen hizmet kimliğinin türü.

Name	Tür	Description
None	string
SystemAssigned	string
UserAssigned	string

PrivateLinkScopedResource

Özel bağlantı kapsamı kaynak başvurusu.

Name	Tür	Description
resourceId	string	Özel bağlantı kapsamı kaynağının tam kaynak kimliği.
scopeId	string	Özel bağlantı kapsamı benzersiz Tanımlayıcısı.

PublicNetworkAccessType

Log Analytics Çalışma Alanı'nda çalışmaya yönelik ağ erişim türü. Varsayılan olarak Etkin'dir

Name	Tür	Description
Disabled	string	Genel DNS aracılığıyla Log Analytics'e genel bağlantıyı devre dışı bırakır.
Enabled	string	Genel DNS aracılığıyla Log Analytics'e bağlantı sağlar.

systemData

Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.

Name	Tür	Description
createdAt	string	Kaynak oluşturma (UTC) zaman damgası.
createdBy	string	Kaynağı oluşturan kimlik.
createdByType	createdByType	Kaynağı oluşturan kimliğin türü.
lastModifiedAt	string	Kaynağın son değişikliğinin zaman damgası (UTC)
lastModifiedBy	string	Kaynağı en son değiştiren kimlik.
lastModifiedByType	createdByType	Kaynağı en son değiştiren kimliğin türü.

UserIdentityProperties

Kullanıcı tarafından atanan kimlik özellikleri.

Name	Tür	Description
clientId	string	Kullanıcı tarafından atanan kimliğin istemci kimliği.
principalId	string	Kullanıcı tarafından atanan kimliğin asıl kimliği.

Workspace

En üst düzey Çalışma Alanı kaynak kapsayıcısı.

Name	Tür	Varsayılan değer	Description
etag	string		Çalışma alanının etiketi.
id	string		Kaynağın tam kaynak kimliği. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	Identity		Kaynağın kimliği.
location	string		Kaynağın bulunduğu coğrafi konum
name	string		Kaynağın adı
properties.createdDate	string		Çalışma alanı oluşturma tarihi.
properties.customerId	string		Bu salt okunur bir özelliktir. Çalışma alanıyla ilişkili kimliği temsil eder.
properties.defaultDataCollectionRuleResourceId	string		Bu çalışma alanı için kullanılacak varsayılan Veri Toplama Kuralının kaynak kimliği. Beklenen biçim: - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionRules/{dcrName}.
properties.features	WorkspaceFeatures		Çalışma alanı özellikleri.
properties.forceCmkForQuery	boolean		Sorgu yönetimi için müşteri tarafından yönetilen depolamanın zorunlu olup olmadığını gösterir.
properties.modifiedDate	string		Çalışma alanı değiştirme tarihi.
properties.privateLinkScopedResources	PrivateLinkScopedResource[]		Bağlantılı özel bağlantı kapsamı kaynaklarının listesi.
properties.provisioningState	WorkspaceEntityStatus		Çalışma alanının sağlama durumu.
properties.publicNetworkAccessForIngestion	PublicNetworkAccessType	Enabled	Log Analytics alımına erişmek için ağ erişim türü.
properties.publicNetworkAccessForQuery	PublicNetworkAccessType	Enabled	Log Analytics sorgusuna erişmek için ağ erişim türü.
properties.retentionInDays	integer		Çalışma alanı verilerini gün olarak saklama. İzin verilen değerler fiyatlandırma planına göredir. Ayrıntılar için fiyatlandırma katmanları belgelerine bakın.
properties.sku	WorkspaceSku		Çalışma alanının SKU'su.
properties.workspaceCapping	WorkspaceCapping		Alım için günlük hacim sınırı.
systemData	systemData		Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.
tags	object		Kaynak etiketleri.
type	string		Kaynağın türü. Örneğin, "Microsoft.Compute/virtualMachines" veya "Microsoft.Storage/storageAccounts"

WorkspaceCapping

Alım için günlük hacim sınırı.

Name	Tür	Description
dailyQuotaGb	number	Veri alımı için çalışma alanı günlük kotası.
dataIngestionStatus	DataIngestionStatus	Bu çalışma alanı için veri alımının durumu.
quotaNextResetTime	string	Kotanın ne zaman dinleneceği.

WorkspaceEntityStatus

Çalışma alanının sağlama durumu.

Name	Tür	Description
Canceled	string
Creating	string
Deleting	string
Failed	string
ProvisioningAccount	string
Succeeded	string
Updating	string

WorkspaceFeatures

Çalışma alanı özellikleri.

Name	Tür	Description
clusterResourceId	string	Çalışma alanlarına bağlı ayrılmış LA kümesi resourceId değeri.
disableLocalAuth	boolean	AAD tabanlı olmayan Kimlik Doğrulamasını devre dışı bırakın.
enableDataExport	boolean	Verilerin dışarı aktarılıp aktarılmaması gerektiğini belirten bayrak.
enableLogAccessUsingOnlyResourcePermissions	boolean	Hangi iznin kullanılacağını belirten bayrak : kaynak veya çalışma alanı ya da her ikisi.
immediatePurgeDataOn30Days	boolean	Verileri 30 gün sonra kaldırmak isteyip istemediğinizi açıklayan bayrak.
unifiedSentinelBillingOnly	boolean	Çalışma alanını belirtme işleminin yalnızca Sentinel'in birleşik faturalama modeliyle sınırlı olup olmadığını gösteren bir gösterge.

WorkspaceListResult

Liste çalışma alanları işlem yanıtı.

Name	Tür	Description
value	Workspace[]	Çalışma alanlarının listesi.

WorkspaceSku

Çalışma alanının SKU'su (katman).

Name	Tür	Description
capacityReservationLevel	CapacityReservationLevel	CapacityReservation sku'su seçildiğinde bu çalışma alanının GB olarak kapasite rezervasyon düzeyi.
lastSkuUpdate	string	SKU'nun son güncelleştirilişi.
name	WorkspaceSkuNameEnum	SKU'nun adı.

WorkspaceSkuNameEnum

SKU'nun adı.

Name	Tür	Description
CapacityReservation	string
Free	string
LACluster	string
PerGB2018	string
PerNode	string
Premium	string
Standalone	string
Standard	string