Workspaces - List

Referência

Serviço:: Log Analytics

Versão da API:: 2023-09-01

Obtém as áreas de trabalho numa subscrição.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
subscriptionId	path	True	string	O ID da subscrição de destino.
api-version	query	True	string	A versão da API a utilizar para esta operação.

Respostas

Name	Tipo	Description
200 OK	WorkspaceListResult	Definição de resposta OK.
Other Status Codes	ErrorResponse	Resposta de erro que descreve o motivo pela qual a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

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

Âmbitos

Name	Description
user_impersonation	representar a sua conta de utilizador

Exemplos

WorkspacesSubscriptionList

Pedido de amostra

HTTP

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

Resposta da amostra

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

Definições

Name	Description
CapacityReservationLevel	O nível de reserva de capacidade em GB para esta área de trabalho, quando o SKU CapacityReservation está selecionado.
createdByType	O tipo de identidade que criou o recurso.
DataIngestionStatus	O estado da ingestão de dados para esta área de trabalho.
ErrorAdditionalInfo	Informações adicionais sobre o erro de gestão de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta a erros
Identity	Identidade do recurso.
IdentityType	Tipo de identidade de serviço gerida.
PrivateLinkScopedResource	A referência do recurso de âmbito de ligação privada.
PublicNetworkAccessType	O tipo de acesso de rede para operar na Área de Trabalho do Log Analytics. Por predefinição, está Ativado
systemData	Metadados relativos à criação e última modificação do recurso.
UserIdentityProperties	Propriedades de identidade atribuídas pelo utilizador.
Workspace	O contentor de recursos da Área de Trabalho de nível superior.
WorkspaceCapping	O limite de volume diário para ingestão.
WorkspaceEntityStatus	O estado de aprovisionamento da área de trabalho.
WorkspaceFeatures	Funcionalidades da área de trabalho.
WorkspaceListResult	A resposta da operação de áreas de trabalho de lista.
WorkspaceSku	O SKU (camada) de uma área de trabalho.
WorkspaceSkuNameEnum	O nome do SKU.

CapacityReservationLevel

O nível de reserva de capacidade em GB para esta área de trabalho, quando o SKU CapacityReservation está selecionado.

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

Name	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

DataIngestionStatus

O estado da ingestão de dados para esta área de trabalho.

Name	Tipo	Description
ApproachingQuota	string	80% da quota de limite diário atingida.
ForceOff	string	A ingestão parou após a alteração da definição do serviço.
ForceOn	string	A ingestão começou após a alteração da definição do serviço.
OverQuota	string	Atingiu a quota de limite diário, a ingestão parou.
RespectQuota	string	Ingestão ativada após reposição de quota de limite diária ou ativação da subscrição.
SubscriptionSuspended	string	A ingestão parou após a subscrição suspensa.

ErrorAdditionalInfo

Informações adicionais sobre o erro de gestão de recursos.

Name	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informações adicionais.

ErrorDetail

O detalhe do erro.

Name	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 a erros

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

Identity

Identidade do recurso.

Name	Tipo	Description
principalId	string	O ID principal da identidade do recurso.
tenantId	string	O ID de inquilino do recurso.
type	IdentityType	Tipo de identidade de serviço gerida.
userAssignedIdentities	<string, UserIdentityProperties>	A lista de identidades de utilizador associadas ao recurso. As referências da chave do dicionário de identidade do utilizador serão IDs de recursos do ARM no formulário: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".

IdentityType

Tipo de identidade de serviço gerida.

Name	Tipo	Description
None	string
SystemAssigned	string
UserAssigned	string

PrivateLinkScopedResource

A referência do recurso de âmbito de ligação privada.

Name	Tipo	Description
resourceId	string	O ID de recurso completo do recurso de âmbito de ligação privada.
scopeId	string	O Identificador exclusivo do âmbito de ligação privada.

PublicNetworkAccessType

O tipo de acesso de rede para operar na Área de Trabalho do Log Analytics. Por predefinição, está Ativado

Name	Tipo	Description
Disabled	string	Desativa a conectividade pública ao Log Analytics através do DNS público.
Enabled	string	Permite a conectividade ao Log Analytics através do DNS público.

systemData

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

Name	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 utilizador.

Name	Tipo	Description
clientId	string	O ID de cliente da identidade atribuída pelo utilizador.
principalId	string	O ID principal da identidade atribuída pelo utilizador.

Workspace

O contentor de recursos da Área de Trabalho de nível superior.

Name	Tipo	Default value	Description
etag	string		O etag da área de trabalho.
id	string		ID de recurso completamente qualificado 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 reside o recurso
name	string		O nome do recurso
properties.createdDate	string		Data de criação da área de trabalho.
properties.customerId	string		Esta é uma propriedade só de leitura. Representa o ID associado à área de trabalho.
properties.defaultDataCollectionRuleResourceId	string		O ID de recurso da Regra de Recolha de Dados predefinida a utilizar para esta área de trabalho. O formato esperado é - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionRules/{dcrName}.
properties.features	WorkspaceFeatures		Funcionalidades da área de trabalho.
properties.forceCmkForQuery	boolean		Indica se o armazenamento gerido pelo cliente é obrigatório para a gestão de consultas.
properties.modifiedDate	string		Data de modificação da área de trabalho.
properties.privateLinkScopedResources	PrivateLinkScopedResource[]		Lista de recursos de âmbito de ligação privada ligados.
properties.provisioningState	WorkspaceEntityStatus		O estado de aprovisionamento da área de trabalho.
properties.publicNetworkAccessForIngestion	PublicNetworkAccessType	Enabled	O tipo de acesso de rede para aceder à ingestão do Log Analytics.
properties.publicNetworkAccessForQuery	PublicNetworkAccessType	Enabled	O tipo de acesso de rede para aceder à consulta do Log Analytics.
properties.retentionInDays	integer		A retenção de dados da área de trabalho em dias. Os valores permitidos são por plano de preços. Veja a documentação dos escalões de preço para obter detalhes.
properties.sku	WorkspaceSku		O SKU da área de trabalho.
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		Etiquetas 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.

Name	Tipo	Description
dailyQuotaGb	number	A quota diária da área de trabalho para ingestão.
dataIngestionStatus	DataIngestionStatus	O estado da ingestão de dados para esta área de trabalho.
quotaNextResetTime	string	O tempo em que a quota estará inativa.

WorkspaceEntityStatus

O estado de aprovisionamento da área de trabalho.

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

WorkspaceFeatures

Funcionalidades da área de trabalho.

Name	Tipo	Description
clusterResourceId	string	ResourceId do cluster de LA dedicado que está ligado às áreas de trabalho.
disableLocalAuth	boolean	Desative a Autenticação Não Baseada no AAD.
enableDataExport	boolean	Sinalizador que indica se os dados devem ser exportados.
enableLogAccessUsingOnlyResourcePermissions	boolean	Sinalizador que indica que permissão utilizar - recurso ou área de trabalho ou ambos.
immediatePurgeDataOn30Days	boolean	Sinalizador que descreve se queremos remover os dados após 30 dias.
unifiedSentinelBillingOnly	boolean	Uma indicação se a área de trabalho especificada estiver limitada apenas ao modelo de faturação unificado do Sentinel.

WorkspaceListResult

A resposta da operação de áreas de trabalho de lista.

Name	Tipo	Description
value	Workspace[]	Uma lista de áreas de trabalho.

WorkspaceSku

O SKU (camada) de uma área de trabalho.

Name	Tipo	Description
capacityReservationLevel	CapacityReservationLevel	O nível de reserva de capacidade em GB para esta área de trabalho, quando o SKU CapacityReservation está selecionado.
lastSkuUpdate	string	A última vez que o SKU foi atualizado.
name	WorkspaceSkuNameEnum	O nome do SKU.

WorkspaceSkuNameEnum

O nome do SKU.

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

Partilhar via