Workspaces - Get

Serviço:: Log Analytics

Versão API:: 2025-07-01

Obtém uma instância de espaço de trabalho.

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

Parâmetros URI

Nome	Em	Necessário	Tipo	Descrição
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
subscriptionId	path	True	string minLength: 1	A ID da assinatura de destino.
workspaceName	path	True	string minLength: 4 maxLength: 63 pattern: ^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$	O nome do espaço de trabalho.
api-version	query	True	string minLength: 1	A versão da API a utilizar para esta operação.

Respostas

Nome	Tipo	Descrição
200 OK	Workspace	Definição de resposta OK.
Other Status Codes	ErrorResponse	Resposta de erro descrevendo por que a operação falhou.

Segurança

azure_auth

Azure Ative Directory OAuth2 Flow

Tipo: oauth2
Flow: implicit
URL de autorização: https://login.microsoftonline.com/common/oauth2/authorize

Alcances

Nome	Descrição
user_impersonation	personificar a sua conta de utilizador

Exemplos

WorkspaceGet

Pedido de exemplo

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


/**
 * Samples for Workspaces GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/OperationalInsights/stable/2025-
     * 07-01/examples/WorkspacesGet.json
     */
    /**
     * Sample code: WorkspaceGet.
     * 
     * @param manager Entry point to LogAnalyticsManager.
     */
    public static void workspaceGet(com.azure.resourcemanager.loganalytics.LogAnalyticsManager manager) {
        manager.workspaces().getByResourceGroupWithResponse("oiautorest6685", "oiautorest6685",
            com.azure.core.util.Context.NONE);
    }
}

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

from azure.identity import DefaultAzureCredential

from azure.mgmt.loganalytics import LogAnalyticsManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-loganalytics
# USAGE
    python workspaces_get.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = LogAnalyticsManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-0000-0000-0000-00000000000",
    )

    response = client.workspaces.get(
        resource_group_name="oiautorest6685",
        workspace_name="oiautorest6685",
    )
    print(response)


# x-ms-original-file: specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/OperationalInsights/stable/2025-07-01/examples/WorkspacesGet.json
if __name__ == "__main__":
    main()

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

package armoperationalinsights_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/operationalinsights/armoperationalinsights/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/53d56e4ec74156c450d1e51745a971d3f2031dd7/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/OperationalInsights/stable/2025-07-01/examples/WorkspacesGet.json
func ExampleWorkspacesClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armoperationalinsights.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewWorkspacesClient().Get(ctx, "oiautorest6685", "oiautorest6685", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Workspace = armoperationalinsights.Workspace{
	// 	Name: to.Ptr("oiautorest6685"),
	// 	Type: to.Ptr("Microsoft.OperationalInsights/workspaces"),
	// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-00000000000/resourcegroups/oiautorest6685/providers/microsoft.operationalinsights/workspaces/oiautorest6685"),
	// 	Location: to.Ptr("eastus"),
	// 	Properties: &armoperationalinsights.WorkspaceProperties{
	// 		CustomerID: to.Ptr("5b02755b-5bf4-430c-9487-45502a2a7e62"),
	// 		Failover: &armoperationalinsights.WorkspaceFailoverProperties{
	// 			LastModifiedDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-07-05T07:35:51.000Z"); return t}()),
	// 			State: to.Ptr(armoperationalinsights.WorkspaceFailoverStateActive),
	// 		},
	// 		ProvisioningState: to.Ptr(armoperationalinsights.WorkspaceEntityStatusSucceeded),
	// 		PublicNetworkAccessForIngestion: to.Ptr(armoperationalinsights.PublicNetworkAccessTypeEnabled),
	// 		PublicNetworkAccessForQuery: to.Ptr(armoperationalinsights.PublicNetworkAccessTypeEnabled),
	// 		Replication: &armoperationalinsights.WorkspaceReplicationProperties{
	// 			CreatedDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-07-04T07:35:51.000Z"); return t}()),
	// 			Enabled: to.Ptr(true),
	// 			LastModifiedDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-07-04T07:35:51.000Z"); return t}()),
	// 			Location: to.Ptr("westus3"),
	// 			ProvisioningState: to.Ptr(armoperationalinsights.WorkspaceReplicationStateSucceeded),
	// 		},
	// 		RetentionInDays: to.Ptr[int32](30),
	// 		SKU: &armoperationalinsights.WorkspaceSKU{
	// 			Name: to.Ptr(armoperationalinsights.WorkspaceSKUNameEnumPerGB2018),
	// 		},
	// 	},
	// }
}

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

const { OperationalInsightsManagementClient } = require("@azure/arm-operationalinsights");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Gets a workspace instance.
 *
 * @summary Gets a workspace instance.
 * x-ms-original-file: specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/OperationalInsights/stable/2025-07-01/examples/WorkspacesGet.json
 */
async function workspaceGet() {
  const subscriptionId =
    process.env["OPERATIONALINSIGHTS_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-00000000000";
  const resourceGroupName = process.env["OPERATIONALINSIGHTS_RESOURCE_GROUP"] || "oiautorest6685";
  const workspaceName = "oiautorest6685";
  const credential = new DefaultAzureCredential();
  const client = new OperationalInsightsManagementClient(credential, subscriptionId);
  const result = await client.workspaces.get(resourceGroupName, workspaceName);
  console.log(result);
}

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

Resposta de exemplo

Código de estado:: 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"
}

Definições

Nome	Descrição
createdByType	O tipo de identidade que criou o recurso.
DataIngestionStatus	O status da ingestão de dados para este espaço de trabalho.
ErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
Identity	Identidade do recurso.
PrivateLinkScopedResource	Lista de recursos de escopo de link privado vinculados.
PublicNetworkAccessType	O tipo de acesso à rede para acessar a ingestão do Log Analytics.
ResourceIdentityType	O tipo de identidade.
systemData	Metadados referentes à criação e última modificação do recurso.
Workspace	O contêiner de recursos de espaço de trabalho de nível superior.
WorkspaceCapping	A tampa de volume diária para ingestão.
WorkspaceEntityStatus	O estado de provisionamento do espaço de trabalho.
WorkspaceFailoverProperties	propriedades de failover do espaço de trabalho.
WorkspaceFailoverState	O estado de failover da replicação.
WorkspaceFeatures	Recursos do espaço de trabalho.
WorkspaceReplicationProperties	propriedades de replicação do espaço de trabalho.
WorkspaceReplicationState	O estado de provisionamento da replicação.
WorkspaceSku	A SKU do espaço de trabalho.
WorkspaceSkuNameEnum	O nome do SKU.

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Descrição
User
Application
ManagedIdentity
Key

DataIngestionStatus

Enumeração

O status da ingestão de dados para este espaço de trabalho.

Valor	Descrição
RespectQuota	Ingestão ativada após redefinição de cota de limite diário ou ativação de assinatura.
ForceOn	A ingestão começou após a alteração da configuração do serviço.
ForceOff	A ingestão parou após a alteração da configuração do serviço.
OverQuota	Atingida a quota máxima diária, a ingestão parou.
SubscriptionSuspended	A ingestão parou após a suspensão da assinatura.
ApproachingQuota	80% da quota máxima diária atingida.

ErrorAdditionalInfo

Objetivo

O erro de gerenciamento de recursos informações adicionais.

Nome	Tipo	Descrição
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Objetivo

O detalhe do erro.

Nome	Tipo	Descrição
additionalInfo	ErrorAdditionalInfo[]	O erro informações adicionais.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Objetivo

Resposta de erro

Nome	Tipo	Descrição
error	ErrorDetail	O objeto de erro.

Identity

Objetivo

Identidade do recurso.

Nome	Tipo	Descrição
principalId	string (uuid)	A ID principal da identidade do recurso. O valor deve ser um UUID.
tenantId	string (uuid)	A ID do locatário do recurso. O valor deve ser um UUID.
type	ResourceIdentityType	O tipo de identidade.

PrivateLinkScopedResource

Objetivo

Lista de recursos de escopo de link privado vinculados.

Nome	Tipo	Descrição
resourceId	string	O ID de recurso completo do recurso de escopo de link privado.
scopeId	string	O identificador exclusivo do escopo do link privado.

PublicNetworkAccessType

Enumeração

O tipo de acesso à rede para acessar a ingestão do Log Analytics.

Valor	Descrição
Enabled	Permite a conectividade com o Log Analytics por meio de DNS público.
Disabled	Desabilita a conectividade pública com o Log Analytics por meio de DNS público.
SecuredByPerimeter	O recurso só é acessível a partir de redes privadas e acesso aprovado pelo perímetro de segurança de rede associado a este recurso.

ResourceIdentityType

Enumeração

O tipo de identidade.

Valor	Descrição
SystemAssigned

systemData

Objetivo

Metadados referentes à criação e última modificação do recurso.

Nome	Tipo	Descrição
createdAt	string (date-time)	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.

Workspace

Objetivo

O contêiner de recursos de espaço de trabalho de nível superior.

Nome	Tipo	Valor padrão	Descrição
etag	string		A etag do espaço de trabalho.
id	string		ID de recurso totalmente qualificado para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	Identity		A identidade do recurso.
location	string		A geolocalização onde o recurso vive
name	string		O nome do recurso
properties.createdDate	string (date-time)		Data de criação do espaço de trabalho.
properties.customerId	string		Esta é uma propriedade somente leitura. Representa a ID associada ao espaço de trabalho.
properties.defaultDataCollectionRuleResourceId	string		A ID do recurso da Regra de Coleta de Dados padrão a ser usada para este espaço de trabalho. O formato esperado é - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionRules/{dcrName}.
properties.failover	WorkspaceFailoverProperties		propriedades de failover do espaço de trabalho.
properties.features	WorkspaceFeatures		Recursos do espaço de trabalho.
properties.forceCmkForQuery	boolean		Indica se o armazenamento gerenciado pelo cliente é obrigatório para o gerenciamento de consultas.
properties.modifiedDate	string (date-time)		Data de modificação do espaço de trabalho.
properties.privateLinkScopedResources	PrivateLinkScopedResource[]		Lista de recursos de escopo de link privado vinculados.
properties.provisioningState	WorkspaceEntityStatus		O estado de provisionamento do espaço de trabalho.
properties.publicNetworkAccessForIngestion	PublicNetworkAccessType	Enabled	O tipo de acesso à rede para acessar a ingestão do Log Analytics.
properties.publicNetworkAccessForQuery	PublicNetworkAccessType	Enabled	O tipo de acesso à rede para acessar a consulta do Log Analytics.
properties.replication	WorkspaceReplicationProperties		propriedades de replicação do espaço de trabalho.
properties.retentionInDays	integer (int32)		A retenção de dados do espaço de trabalho, medida em dias. Os valores permitidos são por plano de preços. Consulte a documentação dos níveis de preços para obter detalhes.
properties.sku	WorkspaceSku		A SKU do espaço de trabalho.
properties.workspaceCapping	WorkspaceCapping		A tampa de volume diária para ingestão.
systemData	systemData		Metadados referentes à criação e última modificação do recurso.
tags	object		Tags de recursos.
type	string		O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

WorkspaceCapping

Objetivo

A tampa de volume diária para ingestão.

Nome	Tipo	Descrição
dailyQuotaGb	number (double)	A quota diária do espaço de trabalho para ingestão.
dataIngestionStatus	DataIngestionStatus	O status da ingestão de dados para este espaço de trabalho.
quotaNextResetTime	string	O tempo em que a cota será de descanso.

WorkspaceEntityStatus

Enumeração

O estado de provisionamento do espaço de trabalho.

Valor	Descrição
Creating
Succeeded
Failed
Canceled
Deleting
ProvisioningAccount
Updating

WorkspaceFailoverProperties

Objetivo

propriedades de failover do espaço de trabalho.

Nome	Tipo	Descrição
lastModifiedDate	string (date-time)	A última vez em que o estado de failover foi atualizado.
state	WorkspaceFailoverState	O estado de failover da replicação.

WorkspaceFailoverState

Enumeração

O estado de failover da replicação.

Valor	Descrição
Inactive
Activating
Active
Deactivating
Failed

WorkspaceFeatures

Objetivo

Recursos do espaço de trabalho.

Nome	Tipo	Descrição
associations	string[]	Lista de associações para o espaço de trabalho. Indica se o espaço de trabalho está associado a alguma das seguintes experiências: MDC, Sentinel, SentinelGraph, etc.
clusterResourceId	string	ResourceId de cluster LA dedicado que está vinculado aos espaços de trabalho.
disableLocalAuth	boolean	Desative a autenticação não baseada em AAD.
enableDataExport	boolean	Sinalizador que indica se os dados devem ser exportados.
enableLogAccessUsingOnlyResourcePermissions	boolean	Sinalizador que indica qual permissão usar - recurso ou espaço de trabalho ou ambos.
immediatePurgeDataOn30Days	boolean	Sinalizador que descreve se queremos remover os dados após 30 dias.
unifiedSentinelBillingOnly	boolean	Uma indicação se o espaço de trabalho de especificação está limitado apenas ao modelo de faturamento unificado do sentinel.

WorkspaceReplicationProperties

Objetivo

propriedades de replicação do espaço de trabalho.

Nome	Tipo	Descrição
createdDate	string (date-time)	A última vez em que a replicação foi habilitada.
enabled	boolean	Especifica se a replicação está habilitada ou não. Quando verdadeiro, a configuração e os dados do espaço de trabalho são replicados para o local especificado. Se a replicação estiver habilitada, o local deverá ser fornecido.
lastModifiedDate	string (date-time)	A última vez em que a replicação foi atualizada.
location	string	O local da replicação.
provisioningState	WorkspaceReplicationState	O estado de provisionamento da replicação.

WorkspaceReplicationState

Enumeração

O estado de provisionamento da replicação.

Valor	Descrição
Succeeded
EnableRequested
Enabling
DisableRequested
Disabling
RollbackRequested
RollingBack
Failed
Canceled

WorkspaceSku

Objetivo

A SKU do espaço de trabalho.

Nome	Tipo	Descrição
capacityReservationLevel	integer (int32)	O nível de reserva de capacidade em GB para este espaço de trabalho, quando CapacityReservation sku é selecionado.
lastSkuUpdate	string (date-time)	A última vez em que o sku foi atualizado.
name	WorkspaceSkuNameEnum	O nome do SKU.

WorkspaceSkuNameEnum

Enumeração

O nome do SKU.

Valor	Descrição
Free
Standard
Premium
PerNode
PerGB2018
Standalone
CapacityReservation
LACluster

Partilhar via

Workspaces - Get

Parâmetros URI

Respostas

Segurança

azure_auth

Alcances

Exemplos

WorkspaceGet

Pedido de exemplo

Resposta de exemplo

Definições

createdByType

DataIngestionStatus

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

Identity

PrivateLinkScopedResource

PublicNetworkAccessType

ResourceIdentityType

systemData

Workspace

WorkspaceCapping

WorkspaceEntityStatus

WorkspaceFailoverProperties

WorkspaceFailoverState

WorkspaceFeatures

WorkspaceReplicationProperties

WorkspaceReplicationState

WorkspaceSku

WorkspaceSkuNameEnum