Workspaces - List

Referencia

Servicio:: Log Analytics

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

Obtiene las áreas de trabajo de una suscripción.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
subscriptionId	path	True	string	Identificador de la suscripción de destino.
api-version	query	True	string	Versión de API que se usará para la operación.

Respuestas

Nombre	Tipo	Description
200 OK	WorkspaceListResult	Definición de respuesta correcta.
Other Status Codes	ErrorResponse	Respuesta de error que describe el motivo del error de la operación.

Seguridad

azure_auth

Flujo 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	suplantación de su cuenta de usuario

Ejemplos

WorkspacesSubscriptionList

Solicitud de ejemplo

HTTP

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

Respuesta de muestra

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

Definiciones

Nombre	Description
CapacityReservationLevel	Nivel de reserva de capacidad en GB para este á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 relacionados con la creación y la ú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 diario del volumen para la ingesta.
WorkspaceEntityStatus	Estado de aprovisionamiento del área de trabajo.
WorkspaceFeatures	Características del área de trabajo.
WorkspaceListResult	Respuesta de la operación de lista de áreas de trabajo.
WorkspaceSku	SKU (nivel) de un área de trabajo.
WorkspaceSkuNameEnum	El nombre de la SKU.

CapacityReservationLevel

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

Nombre	Tipo	Description
100	Integer
1000	Integer
10000	Integer
200	Integer
2000	Integer
25000	Integer
300	Integer
400	Integer
500	Integer
5000	Integer
50000	Integer

createdByType

Tipo de identidad que creó el recurso.

Nombre	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

DataIngestionStatus

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

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

ErrorAdditionalInfo

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

Detalle del error.

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

ErrorResponse

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

Identity

Identidad del recurso.

Nombre	Tipo	Description
principalId	string	Identificador de entidad de seguridad de la identidad de 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

Tipo de identidad de servicio administrada.

Nombre	Tipo	Description
None	string
SystemAssigned	string
UserAssigned	string

PrivateLinkScopedResource

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

Nombre	Tipo	Description
resourceId	string	El identificador de recurso completo del recurso de ámbito de vínculo privado.
scopeId	string	Identificador único del á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

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

systemData

Metadatos relacionados con la creación y la última modificación del recurso.

Nombre	Tipo	Description
createdAt	string	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	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

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

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

Nombre	Tipo	Valor predeterminado	Description
etag	string		Etag del área de trabajo.
id	string		Identificador de recurso completo del 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		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 obtener más información.
properties.sku	WorkspaceSku		SKU del área de trabajo.
properties.workspaceCapping	WorkspaceCapping		Límite diario del volumen para la ingesta.
systemData	systemData		Metadatos relacionados con la creación y la última modificación del recurso.
tags	object		Etiquetas del recurso.
type	string		Tipo de recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

WorkspaceCapping

Límite diario del volumen para la ingesta.

Nombre	Tipo	Description
dailyQuotaGb	number	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 a la que se restará la cuota.

WorkspaceEntityStatus

Estado de aprovisionamiento del área de trabajo.

Nombre	Tipo	Description
Canceled	string
Creating	string
Deleting	string
Failed	string
ProvisioningAccount	string
Succeeded	string
Updating	string

WorkspaceFeatures

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 está limitada solo al modelo de facturación unificado de Sentinel.

WorkspaceListResult

Respuesta de la operación de lista de áreas de trabajo.

Nombre	Tipo	Description
value	Workspace[]	Lista de áreas de trabajo.

WorkspaceSku

SKU (nivel) de un área de trabajo.

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

WorkspaceSkuNameEnum

El nombre de la SKU.

Nombre	Tipo	Description
CapacityReservation	string
Free	string
LACluster	string
PerGB2018	string
PerNode	string
Premium	string
Standalone	string
Standard	string

Compartir a través de