Workspaces - Update

Referência

Service:: Log Analytics

API Version:: 2023-09-01

Atualizações uma área de trabalho.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
resourceGroupName	path	True	string	O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas.
subscriptionId	path	True	string	O ID da subscrição de destino.
workspaceName	path	True	string	O nome da área de trabalho. Regex pattern: `^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$`
api-version	query	True	string	A versão da API a utilizar para esta operação.

Corpo do Pedido

Name	Tipo	Description
identity	Identity	A identidade do recurso.
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.publicNetworkAccessForIngestion	PublicNetworkAccessType	O tipo de acesso de rede para aceder à ingestão do Log Analytics.
properties.publicNetworkAccessForQuery	PublicNetworkAccessType	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.
tags	object	Etiquetas de recursos. Opcional.

Respostas

Name	Tipo	Description
200 OK	Workspace	A área de trabalho existente foi atualizada com êxito. Verifique provisioningStatus para ver o estado detalhado.
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

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	representar a sua conta de utilizador

Exemplos

WorkspacesPatch

Sample Request

HTTP

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

{
  "properties": {
    "sku": {
      "name": "PerGB2018"
    },
    "retentionInDays": 30,
    "workspaceCapping": {
      "dailyQuotaGb": -1
    }
  }
}

Sample Response

Status code:: 200

{
  "properties": {
    "sku": {
      "name": "PerGB2018"
    },
    "retentionInDays": 30,
    "publicNetworkAccessForQuery": "Enabled",
    "publicNetworkAccessForIngestion": "Enabled",
    "workspaceCapping": {
      "dailyQuotaGb": -1,
      "quotaNextResetTime": "Mon, 16 Nov 2020 15:00:00 GMT",
      "dataIngestionStatus": "RespectQuota"
    }
  },
  "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 de recursos do âmbito da 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.
WorkspacePatch	O contentor de recursos da Área de Trabalho de nível superior.
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ária atingida.
ForceOff	string	A ingestão deixou de seguir a alteração da definição do serviço.
ForceOn	string	A ingestão começou a seguir à alteração da definição de serviço.
OverQuota	string	Atingiu a quota de limite diário, a ingestão parou.
RespectQuota	string	Ingestão ativada após a reposição diária da quota de limite 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 de recurso.
tenantId	string	O ID do 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 de recursos do âmbito da ligação privada.

Name	Tipo	Description
resourceId	string	O ID de recurso completo do recurso de âmbito da ligação privada.
scopeId	string	O Identificador exclusivo do âmbito da 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	Valor Predefinido	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 o recurso se encontra
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ções privadas ligadas.
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 de 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	A hora 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.

WorkspacePatch