Workspaces - Get

Referencia

Servicio:: Log Analytics

Versión de la API:: 2023-09-01

Obtiene una instancia del área de trabajo.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.
subscriptionId	path	True	string minLength: 1	Identificador de la suscripción de destino.
workspaceName	path	True	string minLength: 4 maxLength: 63 pattern: ^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$	Nombre del área de trabajo.
api-version	query	True	string minLength: 1	Versión de la API que se va a usar para esta operación.

Respuestas

Nombre	Tipo	Description
200 OK	Workspace	Definición de respuesta correcta.
Other Status Codes	ErrorResponse	Respuesta de error que describe por qué se produjo un error en la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

WorkspaceGet

Solicitud de ejemplo

HTTP

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

Respuesta de muestra

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

Definiciones

Nombre	Description
CapacityReservationLevel	Nivel de reserva de capacidad en GB para esta área de trabajo, cuando se selecciona capacityReservation sku.
createdByType	Tipo de identidad que creó el recurso.
DataIngestionStatus	Estado de la ingesta de datos para esta área de trabajo.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
Identity	Identidad del recurso.
IdentityType	Tipo de identidad de servicio administrada.
PrivateLinkScopedResource	Referencia de recursos de ámbito de vínculo privado.
PublicNetworkAccessType	Tipo de acceso de red para funcionar en el área de trabajo de Log Analytics. De forma predeterminada, está habilitado
systemData	Metadatos relativos a la creación y última modificación del recurso.
UserIdentityProperties	Propiedades de identidad asignadas por el usuario.
Workspace	Contenedor de recursos del área de trabajo de nivel superior.
WorkspaceCapping	Límite de volumen diario para la ingesta.
WorkspaceEntityStatus	Estado de aprovisionamiento del área de trabajo.
WorkspaceFeatures	Características del área de trabajo.
WorkspaceSku	SKU (nivel) de un área de trabajo.
WorkspaceSkuNameEnum	Nombre de la SKU.

CapacityReservationLevel

Enumeración

Nivel de reserva de capacidad en GB para esta área de trabajo, cuando se selecciona capacityReservation sku.

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

createdByType

Enumeración

Tipo de identidad que creó el recurso.

Valor	Description
Application
Key
ManagedIdentity
User

DataIngestionStatus

Enumeración

Estado de la ingesta de datos para esta área de trabajo.

Valor	Description
ApproachingQuota	80% de la cuota de límite diario alcanzado.
ForceOff	La ingesta se detuvo después del cambio de configuración del servicio.
ForceOn	La ingesta comenzó después del cambio de configuración del servicio.
OverQuota	Se alcanzó la cuota de límite diario, la ingesta se detuvo.
RespectQuota	Ingesta habilitada después del restablecimiento de cuota de límite diario o habilitación de la suscripción.
SubscriptionSuspended	La ingesta se detuvo después de la suscripción suspendida.

ErrorAdditionalInfo

Object

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Object

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Detalles del error.
message	string	Mensaje de error.
target	string	Destino del error.

ErrorResponse

Object

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

Identity

Object

Identidad del recurso.

Nombre	Tipo	Description
principalId	string	Identificador de entidad de seguridad de la identidad del recurso.
tenantId	string	Identificador de inquilino del recurso.
type	IdentityType	Tipo de identidad de servicio administrada.
userAssignedIdentities	<string, UserIdentityProperties>	Lista de identidades de usuario asociadas al recurso. Las referencias de clave de diccionario de identidad de usuario serán identificadores de recursos de ARM con el formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

IdentityType

Enumeración

Tipo de identidad de servicio administrada.

Valor	Description
None
SystemAssigned
UserAssigned

PrivateLinkScopedResource

Object

Referencia de recursos de ámbito de vínculo privado.

Nombre	Tipo	Description
resourceId	string	Identificador de recurso completo del recurso de ámbito de vínculo privado.
scopeId	string	Identificador único del ámbito de vínculo privado.

PublicNetworkAccessType

Enumeración

Tipo de acceso de red para funcionar en el área de trabajo de Log Analytics. De forma predeterminada, está habilitado

Valor	Description
Disabled	Deshabilita la conectividad pública a Log Analytics a través de DNS público.
Enabled	Permite la conectividad a Log Analytics a través de DNS público.

systemData

Object

Metadatos relativos a la creación y última modificación del recurso.

Nombre	Tipo	Description
createdAt	string (date-time)	Marca de tiempo de creación de recursos (UTC).
createdBy	string	Identidad que creó el recurso.
createdByType	createdByType	Tipo de identidad que creó el recurso.
lastModifiedAt	string (date-time)	Marca de tiempo de la última modificación del recurso (UTC)
lastModifiedBy	string	Identidad que modificó por última vez el recurso.
lastModifiedByType	createdByType	Tipo de identidad que modificó por última vez el recurso.

UserIdentityProperties

Object

Propiedades de identidad asignadas por el usuario.

Nombre	Tipo	Description
clientId	string	Identificador de cliente de la identidad asignada por el usuario.
principalId	string	Identificador principal de la identidad asignada por el usuario.

Workspace

Object

Contenedor de recursos del área de trabajo de nivel superior.

Nombre	Tipo	Valor predeterminado	Description
etag	string		Etiqueta etag del área de trabajo.
id	string		Identificador de recurso completo para el recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	Identity		Identidad del recurso.
location	string		Ubicación geográfica donde reside el recurso
name	string		Nombre del recurso
properties.createdDate	string		Fecha de creación del área de trabajo.
properties.customerId	string		Se trata de una propiedad de solo lectura. Representa el identificador asociado al área de trabajo.
properties.defaultDataCollectionRuleResourceId	string		Identificador de recurso de la regla de recopilación de datos predeterminada que se va a usar para esta área de trabajo. El formato esperado es : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionRules/{dcrName}.
properties.features	WorkspaceFeatures		Características del área de trabajo.
properties.forceCmkForQuery	boolean		Indica si el almacenamiento administrado por el cliente es obligatorio para la administración de consultas.
properties.modifiedDate	string		Fecha de modificación del área de trabajo.
properties.privateLinkScopedResources	PrivateLinkScopedResource[]		Lista de recursos de ámbito de vínculo privado vinculados.
properties.provisioningState	WorkspaceEntityStatus		Estado de aprovisionamiento del área de trabajo.
properties.publicNetworkAccessForIngestion	PublicNetworkAccessType	Enabled	Tipo de acceso de red para acceder a la ingesta de Log Analytics.
properties.publicNetworkAccessForQuery	PublicNetworkAccessType	Enabled	Tipo de acceso de red para acceder a la consulta de Log Analytics.
properties.retentionInDays	integer (int32)		Retención de datos del área de trabajo en días. Los valores permitidos son por plan de precios. Consulte la documentación de planes de tarifa para más información.
properties.sku	WorkspaceSku		SKU del área de trabajo.
properties.workspaceCapping	WorkspaceCapping		Límite de volumen diario para la ingesta.
systemData	systemData		Metadatos relativos a la creación y última modificación del recurso.
tags	object		Etiquetas de recursos.
type	string		Tipo del recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

WorkspaceCapping

Object

Límite de volumen diario para la ingesta.

Nombre	Tipo	Description
dailyQuotaGb	number (double)	Cuota diaria del área de trabajo para la ingesta.
dataIngestionStatus	DataIngestionStatus	Estado de la ingesta de datos para esta área de trabajo.
quotaNextResetTime	string	Hora en que la cuota estará en reposo.

WorkspaceEntityStatus

Enumeración

Estado de aprovisionamiento del área de trabajo.

Valor	Description
Canceled
Creating
Deleting
Failed
ProvisioningAccount
Succeeded
Updating

WorkspaceFeatures

Object

Características del área de trabajo.

Nombre	Tipo	Description
clusterResourceId	string	ResourceId de clúster de LA dedicado que está vinculado a las áreas de trabajo.
disableLocalAuth	boolean	Deshabilite la autenticación no basada en AAD.
enableDataExport	boolean	Marca que indica si se deben exportar los datos.
enableLogAccessUsingOnlyResourcePermissions	boolean	Marca que indica qué permiso usar: recurso o área de trabajo o ambos.
immediatePurgeDataOn30Days	boolean	Marca que describe si queremos quitar los datos después de 30 días.
unifiedSentinelBillingOnly	boolean	Indicación de si el área de trabajo de especificación solo está limitada al modelo de facturación unificada de Sentinel.

WorkspaceSku

Object

SKU (nivel) de un área de trabajo.

Nombre	Tipo	Description
capacityReservationLevel	CapacityReservationLevel (int32)	Nivel de reserva de capacidad en GB para esta área de trabajo, cuando se selecciona capacityReservation sku.
lastSkuUpdate	string	La última vez que se actualizó la SKU.
name	WorkspaceSkuNameEnum	Nombre de la SKU.

WorkspaceSkuNameEnum

Enumeración

Nombre de la SKU.

Valor	Description
CapacityReservation
Free
LACluster
PerGB2018
PerNode
Premium
Standalone
Standard

Compartir a través de

Workspaces - Get

Parámetros de identificador URI

Respuestas

Seguridad

azure_auth

Ámbitos

Ejemplos

WorkspaceGet

Solicitud de ejemplo

Respuesta de muestra

Definiciones

CapacityReservationLevel

createdByType

DataIngestionStatus

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

Identity

IdentityType

PrivateLinkScopedResource

PublicNetworkAccessType

systemData

UserIdentityProperties

Workspace

WorkspaceCapping

WorkspaceEntityStatus

WorkspaceFeatures

WorkspaceSku

WorkspaceSkuNameEnum

Recursos adicionales