Compartilhar via


Workspaces - List

Obtém os workspaces em uma assinatura.

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

Parâmetros de URI

Nome Em Obrigatório Tipo Description
subscriptionId
path True

string

A ID da assinatura de destino.

api-version
query True

string

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 do 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=2023-09-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
CapacityReservationLevel

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

createdByType

O tipo de identidade que criou o recurso.

DataIngestionStatus

O status de ingestão de dados para esse workspace.

ErrorAdditionalInfo

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

ErrorDetail

Os detalhes do erro.

ErrorResponse

Resposta de erro

Identity

Identidade do recurso.

IdentityType

Tipo de identidade de serviço gerenciada.

PrivateLinkScopedResource

A referência de recurso de escopo do link privado.

PublicNetworkAccessType

O tipo de acesso à rede para operar no workspace do Log Analytics. Por padrão, ele está Habilitado

systemData

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

UserIdentityProperties

Propriedades de identidade atribuídas pelo usuário.

Workspace

O contêiner de recursos de workspace de nível superior.

WorkspaceCapping

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

WorkspaceEntityStatus

O estado de provisionamento do workspace.

WorkspaceFeatures

Recursos do workspace.

WorkspaceListResult

A resposta da operação de workspaces de lista.

WorkspaceSku

O SKU (camada) de um workspace.

WorkspaceSkuNameEnum

O nome da SKU.

CapacityReservationLevel

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

Nome 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

O tipo de identidade que criou o recurso.

Nome Tipo Description
Application

string

Key

string

ManagedIdentity

string

User

string

DataIngestionStatus

O status de ingestão de dados para esse workspace.

Nome Tipo Description
ApproachingQuota

string

80% da cota diária de limite atingido.

ForceOff

string

A ingestão parou após a alteração da configuração de serviço.

ForceOn

string

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

OverQuota

string

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

RespectQuota

string

Ingestão habilitada após a redefinição diária de cota de limite ou habilitação de assinatura.

SubscriptionSuspended

string

A ingestão parou após a assinatura suspensa.

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

Os detalhes 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

A ID da entidade de segurança da identidade do recurso.

tenantId

string

A ID do locatário do recurso.

type

IdentityType

Tipo de identidade de serviço gerenciada.

userAssignedIdentities

<string,  UserIdentityProperties>

A lista de identidades de usuário associadas ao recurso. As referências de chave de dicionário de identidade do usuário serão IDs de recurso do ARM no formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

IdentityType

Tipo de identidade de serviço gerenciada.

Nome Tipo Description
None

string

SystemAssigned

string

UserAssigned

string

PrivateLinkScopedResource

A referência de recurso de escopo do link privado.

Nome Tipo Description
resourceId

string

A ID de recurso completa do recurso de escopo do link privado.

scopeId

string

O identificador exclusivo do escopo do link privado.

PublicNetworkAccessType

O tipo de acesso à rede para operar no workspace do Log Analytics. Por padrão, ele está Habilitado

Nome Tipo Description
Disabled

string

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

Enabled

string

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

systemData

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

Nome Tipo Description
createdAt

string

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

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.

UserIdentityProperties

Propriedades de identidade atribuídas pelo usuário.

Nome Tipo Description
clientId

string

A ID do cliente da identidade atribuída pelo usuário.

principalId

string

A ID principal da identidade atribuída pelo usuário.

Workspace

O contêiner de recursos de workspace de nível superior.

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 em que o recurso reside

name

string

O nome do recurso

properties.createdDate

string

Data de criação do workspace.

properties.customerId

string

Trata-se de uma propriedade somente leitura. Representa a ID associada ao workspace.

properties.defaultDataCollectionRuleResourceId

string

A ID do recurso da Regra de Coleta de Dados padrão a ser usada para esse workspace. O formato esperado é - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionRules/{dcrName}.

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

Data de modificação do workspace.

properties.privateLinkScopedResources

PrivateLinkScopedResource[]

Lista de recursos de escopo de link privado vinculados.

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

integer

A retenção de dados do workspace em dias. Os valores permitidos são por plano de preços. Confira a documentação de tipos de preço 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

Marcas de recurso.

type

string

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

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

dataIngestionStatus

DataIngestionStatus

O status de ingestão de dados para esse workspace.

quotaNextResetTime

string

A hora em que a cota estará em repouso.

WorkspaceEntityStatus

O estado de provisionamento do workspace.

Nome Tipo Description
Canceled

string

Creating

string

Deleting

string

Failed

string

ProvisioningAccount

string

Succeeded

string

Updating

string

WorkspaceFeatures

Recursos do workspace.

Nome Tipo Description
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 de especificação estiver limitado apenas ao modelo de cobrança unificado do Sentinel.

WorkspaceListResult

A resposta da operação de workspaces de lista.

Nome Tipo Description
value

Workspace[]

Uma lista de workspaces.

WorkspaceSku

O SKU (camada) de um workspace.

Nome Tipo Description
capacityReservationLevel

CapacityReservationLevel

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

lastSkuUpdate

string

A última vez em que o sku foi atualizado.

name

WorkspaceSkuNameEnum

O nome da SKU.

WorkspaceSkuNameEnum

O nome da SKU.

Nome Tipo Description
CapacityReservation

string

Free

string

LACluster

string

PerGB2018

string

PerNode

string

Premium

string

Standalone

string

Standard

string