Workspaces - Get

Service:: Log Analytics

API Version:: 2023-09-01

Gets a workspace instance.

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

URI Parameters

Name	In	Required	Type	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string minLength: 1	The ID of the target subscription.
workspaceName	path	True	string minLength: 4 maxLength: 63 pattern: ^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$	The name of the workspace.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	Workspace	OK response definition.
Other Status Codes	ErrorResponse	Error response describing why the operation failed.

Security

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	impersonate your user account

Examples

WorkspaceGet

Sample request

HTTP

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

Sample response

Status code:: 200

{
  "properties": {
    "customerId": "5b02755b-5bf4-430c-9487-45502a2a7e62",
    "provisioningState": "Succeeded",
    "sku": {
      "name": "PerGB2018"
    },
    "retentionInDays": 30,
    "publicNetworkAccessForQuery": "Enabled",
    "publicNetworkAccessForIngestion": "Enabled"
  },
  "id": "/subscriptions/00000000-0000-0000-0000-00000000000/resourcegroups/oiautorest6685/providers/microsoft.operationalinsights/workspaces/oiautorest6685",
  "name": "oiautorest6685",
  "type": "Microsoft.OperationalInsights/workspaces",
  "location": "eastus"
}

Definitions

Name	Description
CapacityReservationLevel	The capacity reservation level in GB for this workspace, when CapacityReservation sku is selected.
createdByType	The type of identity that created the resource.
DataIngestionStatus	The status of data ingestion for this workspace.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
Identity	Identity for the resource.
IdentityType	Type of managed service identity.
PrivateLinkScopedResource	The private link scope resource reference.
PublicNetworkAccessType	The network access type for operating on the Log Analytics Workspace. By default it is Enabled
systemData	Metadata pertaining to creation and last modification of the resource.
UserIdentityProperties	User assigned identity properties.
Workspace	The top level Workspace resource container.
WorkspaceCapping	The daily volume cap for ingestion.
WorkspaceEntityStatus	The provisioning state of the workspace.
WorkspaceFeatures	Workspace features.
WorkspaceSku	The SKU (tier) of a workspace.
WorkspaceSkuNameEnum	The name of the SKU.

CapacityReservationLevel

Enumeration

The capacity reservation level in GB for this workspace, when CapacityReservation sku is selected.

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

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

DataIngestionStatus

Enumeration

The status of data ingestion for this workspace.

Value	Description
RespectQuota	Ingestion enabled following daily cap quota reset, or subscription enablement.
ForceOn	Ingestion started following service setting change.
ForceOff	Ingestion stopped following service setting change.
OverQuota	Reached daily cap quota, ingestion stopped.
SubscriptionSuspended	Ingestion stopped following suspended subscription.
ApproachingQuota	80% of daily cap quota reached.

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

Identity

Object

Identity for the resource.

Name	Type	Description
principalId	string	The principal ID of resource identity.
tenantId	string	The tenant ID of resource.
type	IdentityType	Type of managed service identity.
userAssignedIdentities	<string, UserIdentityProperties>	The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

IdentityType

Enumeration

Type of managed service identity.

Value	Description
SystemAssigned
UserAssigned
None

PrivateLinkScopedResource

Object

The private link scope resource reference.

Name	Type	Description
resourceId	string	The full resource Id of the private link scope resource.
scopeId	string	The private link scope unique Identifier.

PublicNetworkAccessType

Enumeration

The network access type for operating on the Log Analytics Workspace. By default it is Enabled

Value	Description
Enabled	Enables connectivity to Log Analytics through public DNS.
Disabled	Disables public connectivity to Log Analytics through public DNS.

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string (date-time)	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string (date-time)	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.

UserIdentityProperties

Object

User assigned identity properties.

Name	Type	Description
clientId	string	The client id of user assigned identity.
principalId	string	The principal id of user assigned identity.

Workspace

Object

The top level Workspace resource container.

Name	Type	Default value	Description
etag	string		The etag of the workspace.
id	string		Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	Identity		The identity of the resource.
location	string		The geo-location where the resource lives
name	string		The name of the resource
properties.createdDate	string		Workspace creation date.
properties.customerId	string		This is a read-only property. Represents the ID associated with the workspace.
properties.defaultDataCollectionRuleResourceId	string		The resource ID of the default Data Collection Rule to use for this workspace. Expected format is - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionRules/{dcrName}.
properties.features	WorkspaceFeatures		Workspace features.
properties.forceCmkForQuery	boolean		Indicates whether customer managed storage is mandatory for query management.
properties.modifiedDate	string		Workspace modification date.
properties.privateLinkScopedResources	PrivateLinkScopedResource[]		List of linked private link scope resources.
properties.provisioningState	WorkspaceEntityStatus		The provisioning state of the workspace.
properties.publicNetworkAccessForIngestion	PublicNetworkAccessType	Enabled	The network access type for accessing Log Analytics ingestion.
properties.publicNetworkAccessForQuery	PublicNetworkAccessType	Enabled	The network access type for accessing Log Analytics query.
properties.retentionInDays	integer (int32)		The workspace data retention in days. Allowed values are per pricing plan. See pricing tiers documentation for details.
properties.sku	WorkspaceSku		The SKU of the workspace.
properties.workspaceCapping	WorkspaceCapping		The daily volume cap for ingestion.
systemData	systemData		Metadata pertaining to creation and last modification of the resource.
tags	object		Resource tags.
type	string		The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

WorkspaceCapping

Object

The daily volume cap for ingestion.

Name	Type	Description
dailyQuotaGb	number (double)	The workspace daily quota for ingestion.
dataIngestionStatus	DataIngestionStatus	The status of data ingestion for this workspace.
quotaNextResetTime	string	The time when the quota will be rest.

WorkspaceEntityStatus

Enumeration

The provisioning state of the workspace.

Value	Description
Creating
Succeeded
Failed
Canceled
Deleting
ProvisioningAccount
Updating

WorkspaceFeatures

Object

Workspace features.

Name	Type	Description
clusterResourceId	string	Dedicated LA cluster resourceId that is linked to the workspaces.
disableLocalAuth	boolean	Disable Non-AAD based Auth.
enableDataExport	boolean	Flag that indicate if data should be exported.
enableLogAccessUsingOnlyResourcePermissions	boolean	Flag that indicate which permission to use - resource or workspace or both.
immediatePurgeDataOn30Days	boolean	Flag that describes if we want to remove the data after 30 days.
unifiedSentinelBillingOnly	boolean	An indication if the specify workspace is limited to sentinel's unified billing model only.

WorkspaceSku

Object

The SKU (tier) of a workspace.

Name	Type	Description
capacityReservationLevel	CapacityReservationLevel (int32)	The capacity reservation level in GB for this workspace, when CapacityReservation sku is selected.
lastSkuUpdate	string	The last time when the sku was updated.
name	WorkspaceSkuNameEnum	The name of the SKU.

WorkspaceSkuNameEnum

Enumeration

The name of the SKU.

Value	Description
Free
Standard
Premium
PerNode
PerGB2018
Standalone
CapacityReservation
LACluster

Share via

Workspaces - Get

URI Parameters

Responses

Security

azure_auth

Scopes

Examples

WorkspaceGet

Sample request

Sample response

Definitions

CapacityReservationLevel

createdByType

DataIngestionStatus

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

Identity

IdentityType

PrivateLinkScopedResource

PublicNetworkAccessType

systemData

UserIdentityProperties

Workspace

WorkspaceCapping

WorkspaceEntityStatus

WorkspaceFeatures

WorkspaceSku

WorkspaceSkuNameEnum