Workspaces - Update

Référence

Service:: Log Analytics

Version d'API:: 2025-02-01

Met à jour un espace de travail.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nom du groupe de ressources. Le nom ne respecte pas la casse.
subscriptionId	path	True	string minLength: 1	ID de l’abonnement cible.
workspaceName	path	True	string minLength: 4 maxLength: 63 pattern: ^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$	Nom de l’espace de travail.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.

Corps de la demande

Nom	Type	Description
identity	Identity	Identité de la ressource.
properties.defaultDataCollectionRuleResourceId	string	ID de ressource de la règle de collecte de données par défaut à utiliser pour cet espace de travail. Le format attendu est : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionRules/{dcrName}.
properties.failover	WorkspaceFailoverProperties	propriétés de basculement de l’espace de travail.
properties.features	WorkspaceFeatures	Fonctionnalités de l’espace de travail.
properties.forceCmkForQuery	boolean	Indique si le stockage géré par le client est obligatoire pour la gestion des requêtes.
properties.publicNetworkAccessForIngestion	PublicNetworkAccessType	Type d’accès réseau pour accéder à l’ingestion Log Analytics.
properties.publicNetworkAccessForQuery	PublicNetworkAccessType	Type d’accès réseau pour accéder à la requête Log Analytics.
properties.replication	WorkspaceReplicationProperties	propriétés de réplication d’espace de travail.
properties.retentionInDays	integer (int32)	Conservation des données de l’espace de travail en jours. Les valeurs autorisées sont définies par plan tarifaire. Pour plus d’informations, consultez la documentation des niveaux tarifaires.
properties.sku	WorkspaceSku	Référence SKU de l’espace de travail.
properties.workspaceCapping	WorkspaceCapping	Limite de volume quotidienne pour l’ingestion.
tags	object	Balises de ressource. Optionnel.

Réponses

Nom	Type	Description
200 OK	Workspace	L’espace de travail existant a été correctement mis à jour. Vérifiez provisioningStatus pour afficher l’état détaillé.
Other Status Codes	ErrorResponse	Réponse d’erreur décrivant pourquoi l’opération a échoué.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	emprunter l’identité de votre compte d’utilisateur

Exemples

WorkspacesPatch

Exemple de requête

HTTP

PATCH 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,
    "workspaceCapping": {
      "dailyQuotaGb": -1
    }
  }
}

Exemple de réponse

Code d’état:: 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"
  }
}

Définitions

Nom	Description
CapacityReservationLevel	Niveau de réservation de capacité en Go pour cet espace de travail, lorsque la référence SKU CapacityReservation est sélectionnée.
createdByType	Type d’identité qui a créé la ressource.
DataIngestionStatus	État de l’ingestion de données pour cet espace de travail.
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur
Identity	Identité de la ressource.
IdentityType	Type d’identité de service managé.
PrivateLinkScopedResource	Informations de référence sur la ressource d’étendue de liaison privée.
PublicNetworkAccessType	Type d’accès réseau pour l’exploitation sur l’espace de travail Log Analytics. Par défaut, il est activé
systemData	Métadonnées relatives à la création et à la dernière modification de la ressource.
UserIdentityProperties	Propriétés d’identité attribuées par l’utilisateur.
Workspace	Conteneur de ressources d’espace de travail de niveau supérieur.
WorkspaceCapping	Limite de volume quotidienne pour l’ingestion.
WorkspaceEntityStatus	État d’approvisionnement de l’espace de travail.
WorkspaceFailoverProperties	État de basculement de la réplication.
WorkspaceFailoverState	État de basculement de la réplication.
WorkspaceFeatures	Fonctionnalités de l’espace de travail.
WorkspacePatch	Conteneur de ressources d’espace de travail de niveau supérieur.
WorkspaceReplicationProperties	Propriétés de réplication de l’espace de travail.
WorkspaceReplicationState	État d’approvisionnement de la réplication.
WorkspaceSku	Référence SKU (niveau) d’un espace de travail.
WorkspaceSkuNameEnum	Nom de la référence SKU.

CapacityReservationLevel

Énumération

Niveau de réservation de capacité en Go pour cet espace de travail, lorsque la référence SKU CapacityReservation est sélectionnée.

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

createdByType

Énumération

Type d’identité qui a créé la ressource.

Valeur	Description
Application
Key
ManagedIdentity
User

DataIngestionStatus

Énumération

État de l’ingestion de données pour cet espace de travail.

Valeur	Description
ApproachingQuota	80% du quota de plafond quotidien atteint.
ForceOff	L’ingestion s’est arrêtée après la modification du paramètre de service.
ForceOn	L’ingestion a commencé à suivre la modification du paramètre de service.
OverQuota	Atteint le quota de limite quotidienne, l’ingestion s’est arrêtée.
RespectQuota	L’ingestion est activée après la réinitialisation quotidienne du quota de limite ou l’activation de l’abonnement.
SubscriptionSuspended	L’ingestion s’est arrêtée après l’abonnement suspendu.

ErrorAdditionalInfo

Object

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires.
type	string	Type d’informations supplémentaire.

ErrorDetail

Object

Détail de l’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d’erreur.
details	ErrorDetail[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

ErrorResponse

Object

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

Identity

Object

Identité de la ressource.

Nom	Type	Description
principalId	string	ID principal de l’identité de ressource.
tenantId	string	ID de locataire de la ressource.
type	IdentityType	Type d’identité de service managé.
userAssignedIdentities	<string, UserIdentityProperties>	Liste des identités utilisateur associées à la ressource. Les références de clé de dictionnaire d’identité utilisateur seront des ID de ressource ARM sous la forme : « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ».

IdentityType

Énumération

Type d’identité de service managé.

Valeur	Description
None
SystemAssigned
UserAssigned

PrivateLinkScopedResource

Object

Informations de référence sur la ressource d’étendue de liaison privée.

Nom	Type	Description
resourceId	string	ID de ressource complet de la ressource d’étendue de liaison privée.
scopeId	string	Identificateur unique de l’étendue de liaison privée.

PublicNetworkAccessType

Énumération

Type d’accès réseau pour l’exploitation sur l’espace de travail Log Analytics. Par défaut, il est activé

Valeur	Description
Disabled	Désactive la connectivité publique à Log Analytics par le biais du DNS public.
Enabled	Permet la connectivité à Log Analytics par le biais du DNS public.

systemData

Object

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom	Type	Description
createdAt	string (date-time)	Horodatage de la création de ressources (UTC).
createdBy	string	Identité qui a créé la ressource.
createdByType	createdByType	Type d’identité qui a créé la ressource.
lastModifiedAt	string (date-time)	Horodatage de la dernière modification de ressource (UTC)
lastModifiedBy	string	Identité qui a modifié la ressource pour la dernière fois.
lastModifiedByType	createdByType	Type d’identité qui a modifié la ressource pour la dernière fois.

UserIdentityProperties

Object

Propriétés d’identité attribuées par l’utilisateur.

Nom	Type	Description
clientId	string	ID client de l’identité affectée par l’utilisateur.
principalId	string	ID principal de l’identité affectée par l’utilisateur.

Workspace

Object

Conteneur de ressources d’espace de travail de niveau supérieur.

Nom	Type	Valeur par défaut	Description
etag	string		Etag de l’espace de travail.
id	string		ID de ressource complet pour la ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	Identity		Identité de la ressource.
location	string		Emplacement géographique où réside la ressource
name	string		Nom de la ressource
properties.createdDate	string (date-time)		Date de création de l’espace de travail.
properties.customerId	string		Il s’agit d’une propriété en lecture seule. Représente l’ID associé à l’espace de travail.
properties.defaultDataCollectionRuleResourceId	string		ID de ressource de la règle de collecte de données par défaut à utiliser pour cet espace de travail. Le format attendu est : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionRules/{dcrName}.
properties.failover	WorkspaceFailoverProperties		propriétés de basculement de l’espace de travail.
properties.features	WorkspaceFeatures		Fonctionnalités de l’espace de travail.
properties.forceCmkForQuery	boolean		Indique si le stockage géré par le client est obligatoire pour la gestion des requêtes.
properties.modifiedDate	string (date-time)		Date de modification de l’espace de travail.
properties.privateLinkScopedResources	PrivateLinkScopedResource[]		Liste des ressources d’étendue de liaison privée liées.
properties.provisioningState	WorkspaceEntityStatus		État d’approvisionnement de l’espace de travail.
properties.publicNetworkAccessForIngestion	PublicNetworkAccessType	Enabled	Type d’accès réseau pour accéder à l’ingestion Log Analytics.
properties.publicNetworkAccessForQuery	PublicNetworkAccessType	Enabled	Type d’accès réseau pour accéder à la requête Log Analytics.
properties.replication	WorkspaceReplicationProperties		propriétés de réplication d’espace de travail.
properties.retentionInDays	integer (int32)		Conservation des données de l’espace de travail en jours. Les valeurs autorisées sont définies par plan tarifaire. Pour plus d’informations, consultez la documentation des niveaux tarifaires.
properties.sku	WorkspaceSku		Référence SKU de l’espace de travail.
properties.workspaceCapping	WorkspaceCapping		Limite de volume quotidienne pour l’ingestion.
systemData	systemData		Métadonnées relatives à la création et à la dernière modification de la ressource.
tags	object		Balises de ressource.
type	string		Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

WorkspaceCapping

Object

Limite de volume quotidienne pour l’ingestion.

Nom	Type	Description
dailyQuotaGb	number (double)	Quota quotidien de l’espace de travail pour l’ingestion.
dataIngestionStatus	DataIngestionStatus	État de l’ingestion de données pour cet espace de travail.
quotaNextResetTime	string	Heure de repos du quota.

WorkspaceEntityStatus

Énumération

État d’approvisionnement de l’espace de travail.

Valeur	Description
Canceled
Creating
Deleting
Failed
ProvisioningAccount
Succeeded
Updating

WorkspaceFailoverProperties

Object

État de basculement de la réplication.

Nom	Type	Description
lastModifiedDate	string (date-time)	Dernière fois que l’état de basculement a été mis à jour.
state	WorkspaceFailoverState	État de basculement de la réplication.

WorkspaceFailoverState

Énumération

État de basculement de la réplication.

Valeur	Description
Activating
Active
Deactivating
Failed
Inactive

WorkspaceFeatures

Object

Fonctionnalités de l’espace de travail.

Nom	Type	Description
clusterResourceId	string	ResourceId de cluster LA dédié lié aux espaces de travail.
disableLocalAuth	boolean	Désactivez l’authentification non basée sur AAD.
enableDataExport	boolean	Indicateur indiquant si les données doivent être exportées.
enableLogAccessUsingOnlyResourcePermissions	boolean	Indicateur qui indique l’autorisation d’utiliser - ressource ou espace de travail ou les deux.
immediatePurgeDataOn30Days	boolean	Indicateur qui décrit si nous voulons supprimer les données après 30 jours.
unifiedSentinelBillingOnly	boolean	Indication si l’espace de travail spécifié est limité au modèle de facturation unifié de Sentinel uniquement.

WorkspacePatch

Object

Conteneur de ressources d’espace de travail de niveau supérieur.

Nom	Type	Valeur par défaut	Description
etag	string		Etag de ressource.
id	string		ID de ressource complet pour la ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	Identity		Identité de la ressource.
name	string		Nom de la ressource
properties.createdDate	string (date-time)		Date de création de l’espace de travail.
properties.customerId	string		Il s’agit d’une propriété en lecture seule. Représente l’ID associé à l’espace de travail.
properties.defaultDataCollectionRuleResourceId	string		ID de ressource de la règle de collecte de données par défaut à utiliser pour cet espace de travail. Le format attendu est : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionRules/{dcrName}.
properties.failover	WorkspaceFailoverProperties		propriétés de basculement de l’espace de travail.
properties.features	WorkspaceFeatures		Fonctionnalités de l’espace de travail.
properties.forceCmkForQuery	boolean		Indique si le stockage géré par le client est obligatoire pour la gestion des requêtes.
properties.modifiedDate	string (date-time)		Date de modification de l’espace de travail.
properties.privateLinkScopedResources	PrivateLinkScopedResource[]		Liste des ressources d’étendue de liaison privée liées.
properties.provisioningState	WorkspaceEntityStatus		État d’approvisionnement de l’espace de travail.
properties.publicNetworkAccessForIngestion	PublicNetworkAccessType	Enabled	Type d’accès réseau pour accéder à l’ingestion Log Analytics.
properties.publicNetworkAccessForQuery	PublicNetworkAccessType	Enabled	Type d’accès réseau pour accéder à la requête Log Analytics.
properties.replication	WorkspaceReplicationProperties		propriétés de réplication d’espace de travail.
properties.retentionInDays	integer (int32)		Conservation des données de l’espace de travail en jours. Les valeurs autorisées sont définies par plan tarifaire. Pour plus d’informations, consultez la documentation des niveaux tarifaires.
properties.sku	WorkspaceSku		Référence SKU de l’espace de travail.
properties.workspaceCapping	WorkspaceCapping		Limite de volume quotidienne pour l’ingestion.
tags	object		Balises de ressource. Optionnel.
type	string		Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

WorkspaceReplicationProperties

Object

Propriétés de réplication de l’espace de travail.

Nom	Type	Description
createdDate	string (date-time)	Dernière fois que la réplication a été activée.
enabled	boolean	Spécifie si la réplication est activée ou non. Lorsque la valeur est true, la configuration et les données de l’espace de travail sont répliquées à l’emplacement spécifié. Si la réplication est activée, l’emplacement doit être fourni.
lastModifiedDate	string (date-time)	Dernière fois que la réplication a été mise à jour.
location	string	Emplacement de la réplication.
provisioningState	WorkspaceReplicationState	État d’approvisionnement de la réplication.

WorkspaceReplicationState

Énumération

État d’approvisionnement de la réplication.

Valeur	Description
Canceled
DisableRequested
Disabling
EnableRequested
Enabling
Failed
RollbackRequested
RollingBack
Succeeded

WorkspaceSku

Object

Référence SKU (niveau) d’un espace de travail.

Nom	Type	Description
capacityReservationLevel	CapacityReservationLevel (int32)	Niveau de réservation de capacité en Go pour cet espace de travail, lorsque la référence SKU CapacityReservation est sélectionnée.
lastSkuUpdate	string (date-time)	Dernière fois que la référence sku a été mise à jour.
name	WorkspaceSkuNameEnum	Nom de la référence SKU.

WorkspaceSkuNameEnum

Énumération

Nom de la référence SKU.

Valeur	Description
CapacityReservation
Free
LACluster
PerGB2018
PerNode
Premium
Standalone
Standard

Partager via

Workspaces - Update

Paramètres URI

Corps de la demande

Réponses

Sécurité

azure_auth

Étendues

Exemples

WorkspacesPatch

Exemple de requête

Exemple de réponse

Définitions

CapacityReservationLevel

createdByType

DataIngestionStatus

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

Identity

IdentityType

PrivateLinkScopedResource

PublicNetworkAccessType

systemData

UserIdentityProperties

Workspace

WorkspaceCapping

WorkspaceEntityStatus

WorkspaceFailoverProperties

WorkspaceFailoverState

WorkspaceFeatures

WorkspacePatch

WorkspaceReplicationProperties

WorkspaceReplicationState

WorkspaceSku

WorkspaceSkuNameEnum

Ressources supplémentaires