Workspaces - Get

서비스:: Log Analytics

API 버전:: 2025-02-01

작업 영역 인스턴스를 가져옵니다.

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	리소스 그룹의 이름입니다. 이름은 대/소문자를 구분하지 않습니다.
subscriptionId	path	True	string minLength: 1	대상 구독의 ID입니다.
workspaceName	path	True	string minLength: 4 maxLength: 63 pattern: ^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$	작업 영역의 이름입니다.
api-version	query	True	string minLength: 1	이 작업에 사용할 API 버전입니다.

응답

Name	형식	Description
200 OK	Workspace	OK 응답 정의입니다.
Other Status Codes	ErrorResponse	작업이 실패한 이유를 설명하는 오류 응답입니다.

보안

azure_auth

Azure Active Directory OAuth2 흐름

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

Name	Description
user_impersonation	사용자 계정 가장

예제

WorkspaceGet

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

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.OperationalInsights.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.OperationalInsights;

// Generated from example definition: specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2025-02-01/examples/WorkspacesGet.json
// this example is just showing the usage of "Workspaces_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "00000000-0000-0000-0000-00000000000";
string resourceGroupName = "oiautorest6685";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this OperationalInsightsWorkspaceResource
OperationalInsightsWorkspaceCollection collection = resourceGroupResource.GetOperationalInsightsWorkspaces();

// invoke the operation
string workspaceName = "oiautorest6685";
NullableResponse<OperationalInsightsWorkspaceResource> response = await collection.GetIfExistsAsync(workspaceName);
OperationalInsightsWorkspaceResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine("Succeeded with null as result");
}
else
{
    // the variable result is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    OperationalInsightsWorkspaceData resourceData = result.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

샘플 응답

상태 코드:: 200

{
  "properties": {
    "customerId": "5b02755b-5bf4-430c-9487-45502a2a7e62",
    "provisioningState": "Succeeded",
    "sku": {
      "name": "PerGB2018"
    },
    "retentionInDays": 30,
    "publicNetworkAccessForQuery": "Enabled",
    "publicNetworkAccessForIngestion": "Enabled",
    "replication": {
      "___location": "westus3",
      "enabled": true,
      "provisioningState": "Succeeded",
      "createdDate": "2020-07-04T07:35:51Z",
      "lastModifiedDate": "2020-07-04T07:35:51Z"
    },
    "failover": {
      "state": "Active",
      "lastModifiedDate": "2020-07-05T07:35:51Z"
    }
  },
  "id": "/subscriptions/00000000-0000-0000-0000-00000000000/resourcegroups/oiautorest6685/providers/microsoft.operationalinsights/workspaces/oiautorest6685",
  "name": "oiautorest6685",
  "type": "Microsoft.OperationalInsights/workspaces",
  "___location": "eastus"
}

정의

Name	Description
CapacityReservationLevel	CapacityReservation sku가 선택된 경우 이 작업 영역에 대한 용량 예약 수준(GB)입니다.
createdByType	리소스를 만든 ID의 형식입니다.
DataIngestionStatus	이 작업 영역에 대한 데이터 수집의 상태입니다.
ErrorAdditionalInfo	리소스 관리 오류 추가 정보입니다.
ErrorDetail	오류 세부 정보입니다.
ErrorResponse	오류 응답
Identity	리소스의 ID입니다.
IdentityType	관리 서비스 ID의 유형입니다.
PrivateLinkScopedResource	연결된 프라이빗 링크 범위 리소스 목록입니다.
PublicNetworkAccessType	Log Analytics 수집에 액세스하기 위한 네트워크 액세스 유형입니다.
systemData	리소스의 생성 및 마지막 수정과 관련된 메타데이터입니다.
UserIdentityProperties	사용자 할당 ID 속성입니다.
Workspace	최상위 작업 영역 리소스 컨테이너입니다.
WorkspaceCapping	수집을 위한 일일 볼륨 한도입니다.
WorkspaceEntityStatus	작업 영역의 프로비전 상태입니다.
WorkspaceFailoverProperties	작업 영역 장애 조치(failover) 속성입니다.
WorkspaceFailoverState	복제의 장애 조치(failover) 상태입니다.
WorkspaceFeatures	작업 영역 기능.
WorkspaceReplicationProperties	작업 영역 복제 속성입니다.
WorkspaceReplicationState	복제의 프로비전 상태입니다.
WorkspaceSku	작업 영역의 SKU입니다.
WorkspaceSkuNameEnum	SKU의 이름입니다.

CapacityReservationLevel

열거형

CapacityReservation sku가 선택된 경우 이 작업 영역에 대한 용량 예약 수준(GB)입니다.

값	Description
100
200
300
400
500
1000
2000
5000
10000
25000
50000

createdByType

열거형

리소스를 만든 ID의 형식입니다.

값	Description
User
Application
ManagedIdentity
Key

DataIngestionStatus

열거형

이 작업 영역에 대한 데이터 수집의 상태입니다.

값	Description
RespectQuota	일일 한도 할당량 재설정 또는 구독 사용 설정에 따라 수집이 활성화되었습니다.
ForceOn	서비스 설정 변경 후 수집이 시작되었습니다.
ForceOff	서비스 설정 변경 후 수집이 중지되었습니다.
OverQuota	일일 한도 할당량에 도달하고 수집이 중지되었습니다.
SubscriptionSuspended	일시 중단된 구독에 따라 수집이 중지되었습니다.
ApproachingQuota	일일 한도 할당량의 80%에 도달했습니다.

ErrorAdditionalInfo

Object

리소스 관리 오류 추가 정보입니다.

Name	형식	Description
info	object	추가 정보입니다.
type	string	추가 정보 유형입니다.

ErrorDetail

Object

오류 세부 정보입니다.

Name	형식	Description
additionalInfo	ErrorAdditionalInfo[]	오류 추가 정보입니다.
code	string	오류 코드입니다.
details	ErrorDetail[]	오류 세부 정보입니다.
message	string	오류 메시지입니다.
target	string	오류 대상입니다.

ErrorResponse

Object

오류 응답

Name	형식	Description
error	ErrorDetail	오류 개체입니다.

Identity

Object

리소스의 ID입니다.

Name	형식	Description
principalId	string	리소스 ID의 보안 주체 ID입니다.
tenantId	string	리소스의 테넌트 ID입니다.
type	IdentityType	관리 서비스 ID의 유형입니다.
userAssignedIdentities	<string, UserIdentityProperties>	리소스와 연결된 사용자 ID 목록입니다. 사용자 ID 사전 키 참조는 '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' 형식의 ARM 리소스 ID입니다.

IdentityType

열거형

관리 서비스 ID의 유형입니다.

값	Description
SystemAssigned
UserAssigned
None

PrivateLinkScopedResource

Object

연결된 프라이빗 링크 범위 리소스 목록입니다.

Name	형식	Description
resourceId	string	프라이빗 링크 범위 리소스의 전체 리소스 ID입니다.
scopeId	string	프라이빗 링크 범위 고유 식별자입니다.

PublicNetworkAccessType

열거형

Log Analytics 수집에 액세스하기 위한 네트워크 액세스 유형입니다.

값	Description
Enabled	공용 DNS를 통해 Log Analytics에 연결할 수 있습니다.
Disabled	공용 DNS를 통해 Log Analytics에 대한 공용 연결을 사용하지 않도록 설정합니다.

systemData

Object

리소스의 생성 및 마지막 수정과 관련된 메타데이터입니다.

Name	형식	Description
createdAt	string (date-time)	리소스 만들기의 타임스탬프(UTC)입니다.
createdBy	string	리소스를 만든 ID입니다.
createdByType	createdByType	리소스를 만든 ID의 형식입니다.
lastModifiedAt	string (date-time)	리소스 마지막 수정의 타임스탬프(UTC)
lastModifiedBy	string	리소스를 마지막으로 수정한 ID입니다.
lastModifiedByType	createdByType	리소스를 마지막으로 수정한 ID의 형식입니다.

UserIdentityProperties

Object

사용자 할당 ID 속성입니다.

Name	형식	Description
clientId	string	사용자 할당 ID의 클라이언트 ID입니다.
principalId	string	사용자 할당 ID의 보안 주체 ID입니다.

Workspace

Object

최상위 작업 영역 리소스 컨테이너입니다.

Name	형식	Default value	Description
etag	string		작업 영역의 etag입니다.
id	string		리소스에 대한 정규화된 리소스 ID입니다. 예 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	Identity		리소스의 ID입니다.
___location	string		리소스가 있는 지리적 위치
name	string		리소스의 이름
properties.createdDate	string (date-time)		작업 영역 만들기 날짜입니다.
properties.customerId	string		읽기 전용 속성입니다. 작업 영역과 연결된 ID를 나타냅니다.
properties.defaultDataCollectionRuleResourceId	string		이 작업 영역에 사용할 기본 데이터 수집 규칙의 리소스 ID입니다. 예상 형식은 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionRules/{dcrName}입니다.
properties.failover	WorkspaceFailoverProperties		작업 영역 장애 조치(failover) 속성입니다.
properties.features	WorkspaceFeatures		작업 영역 기능.
properties.forceCmkForQuery	boolean		고객 관리형 스토리지가 쿼리 관리에 필수인지 여부를 나타냅니다.
properties.modifiedDate	string (date-time)		작업 영역 수정 날짜입니다.
properties.privateLinkScopedResources	PrivateLinkScopedResource[]		연결된 프라이빗 링크 범위 리소스 목록입니다.
properties.provisioningState	WorkspaceEntityStatus		작업 영역의 프로비전 상태입니다.
properties.publicNetworkAccessForIngestion	PublicNetworkAccessType	Enabled	Log Analytics 수집에 액세스하기 위한 네트워크 액세스 유형입니다.
properties.publicNetworkAccessForQuery	PublicNetworkAccessType	Enabled	Log Analytics 쿼리에 액세스하기 위한 네트워크 액세스 유형입니다.
properties.replication	WorkspaceReplicationProperties		작업 영역 복제 속성입니다.
properties.retentionInDays	integer (int32)		작업 영역 데이터 보존 기간(일)입니다. 허용되는 값은 가격 책정 계획에 따라 다릅니다. 자세한 내용은 가격 책정 계층 설명서를 참조하세요.
properties.sku	WorkspaceSku		작업 영역의 SKU입니다.
properties.workspaceCapping	WorkspaceCapping		수집을 위한 일일 볼륨 한도입니다.
systemData	systemData		리소스의 생성 및 마지막 수정과 관련된 메타데이터입니다.
tags	object		리소스 태그.
type	string		리소스의 형식입니다. 예: "Microsoft.Compute/virtualMachines" 또는 "Microsoft.Storage/storageAccounts"

WorkspaceCapping

Object

수집을 위한 일일 볼륨 한도입니다.

Name	형식	Description
dailyQuotaGb	number (double)	수집을 위한 작업 영역 일일 할당량입니다.
dataIngestionStatus	DataIngestionStatus	이 작업 영역에 대한 데이터 수집의 상태입니다.
quotaNextResetTime	string	할당량이 휴지되는 시간입니다.

WorkspaceEntityStatus

열거형

작업 영역의 프로비전 상태입니다.

값	Description
Creating
Succeeded
Failed
Canceled
Deleting
ProvisioningAccount
Updating

WorkspaceFailoverProperties

Object

작업 영역 장애 조치(failover) 속성입니다.

Name	형식	Description
lastModifiedDate	string (date-time)	장애 조치(failover) 상태가 마지막으로 업데이트된 시간입니다.
state	WorkspaceFailoverState	복제의 장애 조치(failover) 상태입니다.

WorkspaceFailoverState

열거형

복제의 장애 조치(failover) 상태입니다.

값	Description
Inactive
Activating
Active
Deactivating
Failed

WorkspaceFeatures

Object

작업 영역 기능.

Name	형식	Description
clusterResourceId	string	작업 영역에 연결된 전용 LA 클러스터 resourceId입니다.
disableLocalAuth	boolean	비 AAD 기반 인증을 사용하지 않도록 설정합니다.
enableDataExport	boolean	데이터를 내보내야 하는지 여부를 나타내는 플래그입니다.
enableLogAccessUsingOnlyResourcePermissions	boolean	사용할 권한(리소스 또는 작업 영역 또는 둘 다)을 나타내는 플래그입니다.
immediatePurgeDataOn30Days	boolean	30일 후에 데이터를 제거할지 설명하는 플래그입니다.
unifiedSentinelBillingOnly	boolean	지정 작업 영역이 sentinel의 통합 청구 모델로만 제한되는지를 나타냅니다.

WorkspaceReplicationProperties

Object

작업 영역 복제 속성입니다.

Name	형식	Description
createdDate	string (date-time)	복제를 사용하도록 설정한 마지막 시간입니다.
enabled	boolean	복제를 사용할지 여부를 지정합니다. true이면 작업 영역 구성 및 데이터가 지정된 위치에 복제됩니다. 복제를 사용하도록 설정한 경우 위치를 제공해야 합니다.
lastModifiedDate	string (date-time)	복제가 마지막으로 업데이트된 시간입니다.
___location	string	복제의 위치입니다.
provisioningState	WorkspaceReplicationState	복제의 프로비전 상태입니다.

WorkspaceReplicationState

열거형

복제의 프로비전 상태입니다.

값	Description
Succeeded
EnableRequested
Enabling
DisableRequested
Disabling
RollbackRequested
RollingBack
Failed
Canceled

WorkspaceSku

Object

작업 영역의 SKU입니다.

Name	형식	Description
capacityReservationLevel	CapacityReservationLevel (int32)	CapacityReservation sku가 선택된 경우 이 작업 영역에 대한 용량 예약 수준(GB)입니다.
lastSkuUpdate	string (date-time)	sku가 마지막으로 업데이트된 시간입니다.
name	WorkspaceSkuNameEnum	SKU의 이름입니다.

WorkspaceSkuNameEnum

열거형

SKU의 이름입니다.

값	Description
Free
Standard
Premium
PerNode
PerGB2018
Standalone
CapacityReservation
LACluster

다음을 통해 공유

Workspaces - Get

URI 매개 변수

응답

보안

azure_auth

범위

예제

WorkspaceGet

샘플 요청

샘플 응답

정의

CapacityReservationLevel

createdByType

DataIngestionStatus

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

Identity

IdentityType

PrivateLinkScopedResource

PublicNetworkAccessType

systemData

UserIdentityProperties

Workspace

WorkspaceCapping

WorkspaceEntityStatus

WorkspaceFailoverProperties

WorkspaceFailoverState

WorkspaceFeatures

WorkspaceReplicationProperties

WorkspaceReplicationState

WorkspaceSku

WorkspaceSkuNameEnum