Compartilhar via


Workspaces - List

Obtém os espaços de trabalho em uma assinatura.

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

Parâmetros de URI

Nome Em Obrigatório Tipo Description
subscriptionId
path True

string

minLength: 1

A ID da assinatura de destino.

api-version
query True

string

minLength: 1

A versão da API a ser usada para esta operação.

Respostas

Nome Tipo Description
200 OK

WorkspaceListResult

Definição de resposta OK.

Other Status Codes

ErrorResponse

Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

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

Escopos

Nome Description
user_impersonation representar sua conta de usuário

Exemplos

WorkspacesSubscriptionList

Solicitação de exemplo

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

Resposta de exemplo

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

Definições

Nome Description
createdByType

O tipo de identidade que criou o recurso.

DataIngestionStatus

O status da ingestão de dados para este workspace.

ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.

ErrorDetail

O detalhe do erro.

ErrorResponse

Resposta de erro

Identity

Identidade do recurso.

PrivateLinkScopedResource

Lista de recursos de escopo de link privado vinculado.

PublicNetworkAccessType

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

ResourceIdentityType

O tipo de identidade.

systemData

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

Workspace

Uma lista de workspaces.

WorkspaceCapping

O limite de volume diário para ingestão.

WorkspaceEntityStatus

O estado de provisionamento do workspace.

WorkspaceFailoverProperties

propriedades de failover do workspace.

WorkspaceFailoverState

O estado de failover da replicação.

WorkspaceFeatures

Recursos do workspace.

WorkspaceListResult

A resposta da operação de espaços de trabalho de lista.

WorkspaceReplicationProperties

propriedades de replicação do workspace.

WorkspaceReplicationState

O estado de provisionamento da replicação.

WorkspaceSku

A SKU do workspace.

WorkspaceSkuNameEnum

O nome da SKU.

createdByType

O tipo de identidade que criou o recurso.

Valor Description
User
Application
ManagedIdentity
Key

DataIngestionStatus

O status da ingestão de dados para este workspace.

Valor Description
RespectQuota

Ingestão habilitada após a redefinição da cota de limite diário ou a ativação da assinatura.

ForceOn

A ingestão começou após a alteração da configuração do serviço.

ForceOff

A ingestão foi interrompida após a alteração da configuração do serviço.

OverQuota

Atingiu a cota de limite diário, a ingestão parou.

SubscriptionSuspended

A ingestão foi interrompida após a suspensão da assinatura.

ApproachingQuota

80% da cota diária de limite atingida.

ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.

Nome Tipo Description
info

object

As informações adicionais.

type

string

O tipo de informação adicional.

ErrorDetail

O detalhe do erro.

Nome Tipo Description
additionalInfo

ErrorAdditionalInfo[]

As informações adicionais do erro.

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

Resposta de erro

Nome Tipo Description
error

ErrorDetail

O objeto de erro.

Identity

Identidade do recurso.

Nome Tipo Description
principalId

string (uuid)

A ID principal da identidade do recurso. O valor deve ser uma UUID.

tenantId

string (uuid)

A ID do locatário do recurso. O valor deve ser uma UUID.

type

ResourceIdentityType

O tipo de identidade.

PrivateLinkScopedResource

Lista de recursos de escopo de link privado vinculado.

Nome Tipo Description
resourceId

string

A ID completa do recurso de escopo de link privado.

scopeId

string

O identificador exclusivo do escopo do link privado.

PublicNetworkAccessType

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

Valor Description
Enabled

Habilita a conectividade com o Log Analytics por meio do DNS público.

Disabled

Desabilita a conectividade pública com o Log Analytics por meio do DNS público.

SecuredByPerimeter

O recurso só pode ser acessado de redes privadas e o acesso é aprovado pelo perímetro de segurança de rede associado a esse recurso.

ResourceIdentityType

O tipo de identidade.

Valor Description
SystemAssigned

systemData

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

Nome Tipo Description
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

Uma lista de workspaces.

Nome Tipo Valor padrão Description
etag

string

A etag do workspace.

id

string

ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

identity

Identity

A identidade do recurso.

location

string

A localização geográfica onde o recurso reside

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 workspace. O formato esperado é - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionRules/{dcrName}.

properties.failover

WorkspaceFailoverProperties

propriedades de failover do workspace.

properties.features

WorkspaceFeatures

Recursos do workspace.

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 vinculado.

properties.provisioningState

WorkspaceEntityStatus

O estado de provisionamento do workspace.

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 workspace.

properties.retentionInDays

integer (int32)

A retenção de dados do workspace em dias. Os valores permitidos são por plano de preços. Consulte a documentação dos tipos de preços para obter detalhes.

properties.sku

WorkspaceSku

A SKU do workspace.

properties.workspaceCapping

WorkspaceCapping

O limite de volume diário para ingestão.

systemData

systemData

Metadados relativos à 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

O limite de volume diário para ingestão.

Nome Tipo Description
dailyQuotaGb

number (double)

A cota diária do workspace para ingestão.

dataIngestionStatus

DataIngestionStatus

O status da ingestão de dados para este workspace.

quotaNextResetTime

string

A hora em que a cota será de descanso.

WorkspaceEntityStatus

O estado de provisionamento do workspace.

Valor Description
Creating
Succeeded
Failed
Canceled
Deleting
ProvisioningAccount
Updating

WorkspaceFailoverProperties

propriedades de failover do workspace.

Nome Tipo Description
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

O estado de failover da replicação.

Valor Description
Inactive
Activating
Active
Deactivating
Failed

WorkspaceFeatures

Recursos do workspace.

Nome Tipo Description
associations

string[]

Lista de associações para o espaço de trabalho. Indica se o workspace está associado a qualquer uma das seguintes experiências: MDC, Sentinel, SentinelGraph etc.

clusterResourceId

string

ResourceId de cluster la dedicado que está vinculado aos workspaces.

disableLocalAuth

boolean

Desabilite a autenticação não baseada no AAD.

enableDataExport

boolean

Sinalizador que indica se os dados devem ser exportados.

enableLogAccessUsingOnlyResourcePermissions

boolean

Sinalizador que indica qual permissão usar – recurso ou workspace ou ambos.

immediatePurgeDataOn30Days

boolean

Sinalizador que descreve se queremos remover os dados após 30 dias.

unifiedSentinelBillingOnly

boolean

Uma indicação se o workspace especificado está limitado apenas ao modelo de cobrança unificado do sentinel.

WorkspaceListResult

A resposta da operação de espaços de trabalho de lista.

Nome Tipo Description
value

Workspace[]

Uma lista de workspaces.

WorkspaceReplicationProperties

propriedades de replicação do workspace.

Nome Tipo Description
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 true, a configuração e os dados do workspace 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

O estado de provisionamento da replicação.

Valor Description
Succeeded
EnableRequested
Enabling
DisableRequested
Disabling
RollbackRequested
RollingBack
Failed
Canceled

WorkspaceSku

A SKU do workspace.

Nome Tipo Description
capacityReservationLevel

integer (int32)

O nível de reserva de capacidade em GB para esse workspace, quando o sku CapacityReservation é selecionado.

lastSkuUpdate

string (date-time)

A última vez em que o sku foi atualizado.

name

WorkspaceSkuNameEnum

O nome da SKU.

WorkspaceSkuNameEnum

O nome da SKU.

Valor Description
Free
Standard
Premium
PerNode
PerGB2018
Standalone
CapacityReservation
LACluster