Workspaces - Create Or Update

Referência

Serviço:: Log Analytics

Versão da API:: 2025-02-01

Crie ou atualize um workspace.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
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 workspace.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
location	True	string	A localização geográfica onde o recurso reside
etag		string	A etag do workspace.
identity		Identity	A identidade do recurso.
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.publicNetworkAccessForIngestion		PublicNetworkAccessType	O tipo de acesso à rede para acessar a ingestão do Log Analytics.
properties.publicNetworkAccessForQuery		PublicNetworkAccessType	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.
tags		object	Marcas de recurso.

Respostas

Nome	Tipo	Description
200 OK	Workspace	Definição de resposta OK.
201 Created	Workspace	Definição de resposta criada.
202 Accepted		Aceitado
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

WorkspacesCreate

Solicitação de exemplo

HTTP

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

{
  "properties": {
    "sku": {
      "name": "PerGB2018"
    },
    "retentionInDays": 30
  },
  "location": "australiasoutheast",
  "tags": {
    "tag1": "val1"
  }
}

Resposta de exemplo

Código de status:: 200

{
  "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"
  },
  "properties": {
    "customerId": "bc089d7b-485c-4aff-a71e-c00f362d8d2f",
    "provisioningState": "Creating",
    "sku": {
      "name": "PerGB2018"
    },
    "retentionInDays": 30,
    "publicNetworkAccessForQuery": "Enabled",
    "publicNetworkAccessForIngestion": "Enabled"
  }
}

Código de status:: 201

{
  "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"
  },
  "properties": {
    "customerId": "bc089d7b-485c-4aff-a71e-c00f362d8d2f",
    "provisioningState": "Creating",
    "sku": {
      "name": "PerGB2018"
    },
    "retentionInDays": 30,
    "publicNetworkAccessForQuery": "Enabled",
    "publicNetworkAccessForIngestion": "Enabled"
  }
}

Código de status:: 202

Definições

Nome	Description
CapacityReservationLevel	O nível de reserva de capacidade em GB para esse workspace, quando o sku CapacityReservation é selecionado.
createdByType	O tipo de identidade que criou o recurso.
DataIngestionStatus	O status da ingestão de dados para esse 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.
IdentityType	Tipo de identidade de serviço gerenciado.
PrivateLinkScopedResource	A referência de recurso de escopo de 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.
WorkspaceFailoverProperties	O estado de failover da replicação.
WorkspaceFailoverState	O estado de failover da replicação.
WorkspaceFeatures	Recursos do workspace.
WorkspaceReplicationProperties	Propriedades de replicação do workspace.
WorkspaceReplicationState	O estado de provisionamento da replicação.
WorkspaceSku	A SKU (camada) de um workspace.
WorkspaceSkuNameEnum	O nome da SKU.

CapacityReservationLevel

Enumeração

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

Valor	Description
100
1000
10000
200
2000
25000
300
400
500
5000
50000

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
Application
Key
ManagedIdentity
User

DataIngestionStatus

Enumeração

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

Valor	Description
ApproachingQuota	80% de cota de limite diária atingida.
ForceOff	A ingestão parou após a alteração da configuração do serviço.
ForceOn	A ingestão começou após a alteração da configuração do serviço.
OverQuota	Atingiu a cota diária de limite, a ingestão parou.
RespectQuota	Ingestão habilitada após a redefinição diária de cota de limite ou habilitação de assinatura.
SubscriptionSuspended	A ingestão foi interrompida após a assinatura suspensa.

ErrorAdditionalInfo

Objeto

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

Objeto

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

Objeto

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

Identity

Objeto

Identidade do recurso.

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

IdentityType

Enumeração

Tipo de identidade de serviço gerenciado.

Valor	Description
None
SystemAssigned
UserAssigned

PrivateLinkScopedResource

Objeto

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

Nome	Tipo	Description
resourceId	string	A ID de recurso completa 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 operar no Workspace do Log Analytics. Por padrão, ele está habilitado

Valor	Description
Disabled	Desabilita a conectividade pública com o Log Analytics por meio do DNS público.
Enabled	Habilita a conectividade com o Log Analytics por meio de DNS público.

systemData

Objeto

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.

UserIdentityProperties

Objeto

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

Objeto

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 onde o recurso reside
name	string		O nome do recurso
properties.createdDate	string (date-time)		Data de criação do workspace.
properties.customerId	string		Esta é 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 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 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.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		Marcas de recurso.
type	string		O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

WorkspaceCapping

Objeto

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 esse workspace.
quotaNextResetTime	string	A hora em que a cota será rest.

WorkspaceEntityStatus

Enumeração

O estado de provisionamento do workspace.

Valor	Description
Canceled
Creating
Deleting
Failed
ProvisioningAccount
Succeeded
Updating

WorkspaceFailoverProperties

Objeto

O estado de failover da replicação.

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

Enumeração

O estado de failover da replicação.

Valor	Description
Activating
Active
Deactivating
Failed
Inactive

WorkspaceFeatures

Objeto

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 especificado está limitado apenas ao modelo de cobrança unificado do Sentinel.

WorkspaceReplicationProperties

Objeto

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

Enumeração

O estado de provisionamento da replicação.

Valor	Description
Canceled
DisableRequested
Disabling
EnableRequested
Enabling
Failed
RollbackRequested
RollingBack
Succeeded

WorkspaceSku

Objeto

A SKU (camada) de um workspace.

Nome	Tipo	Description
capacityReservationLevel	CapacityReservationLevel (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

Enumeração

O nome da SKU.

Valor	Description
CapacityReservation
Free
LACluster
PerGB2018
PerNode
Premium
Standalone
Standard

Compartilhar via

Workspaces - Create Or Update

Parâmetros de URI

Corpo da solicitação

Respostas

Segurança

azure_auth

Escopos

Exemplos

WorkspacesCreate

Solicitação de exemplo

Resposta de exemplo

Definições

CapacityReservationLevel

createdByType

DataIngestionStatus

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

Identity

IdentityType

PrivateLinkScopedResource

PublicNetworkAccessType

systemData

UserIdentityProperties

Workspace

WorkspaceCapping

WorkspaceEntityStatus

WorkspaceFailoverProperties

WorkspaceFailoverState

WorkspaceFeatures

WorkspaceReplicationProperties

WorkspaceReplicationState

WorkspaceSku

WorkspaceSkuNameEnum

Recursos adicionais