Workspaces - Create Or Update

  • Référence
Service:
Log Analytics
API Version:
2023-09-01

Créer ou mettre à jour un espace de travail.

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

Paramètres URI

Nom Dans Obligatoire Type Description
resourceGroupName
 path True

string

Nom du groupe de ressources. Le nom ne respecte pas la casse.
subscriptionId
 path True

string

ID de l’abonnement cible.
workspaceName
 path True

string

Nom de l’espace de travail.

Regex pattern: ^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$
api-version
 query True

string

Version de l’API à utiliser pour cette opération.

Corps de la demande

Nom Obligatoire Type Description
location True

string

Emplacement géographique où réside la ressource
etag

string

Etag de l’espace de travail.
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. Format attendu : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionRules/{dcrName}.
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.retentionInDays

integer

Conservation des données de l’espace de travail en jours. Les valeurs autorisées sont par plan tarifaire. Pour plus d’informations, consultez la documentation relative aux niveaux tarifaires.
properties.sku

WorkspaceSku

Référence SKU de l’espace de travail.
properties.workspaceCapping

WorkspaceCapping

Limite de volume quotidien pour l’ingestion.
tags

object

Balises de ressource.

Réponses

Nom Type Description
200 OK

Workspace

Définition de réponse OK.
201 Created

Workspace

Définition de réponse créée.
202 Accepted

Accepté
Other Status Codes

ErrorResponse

Réponse d’erreur décrivant la raison de l’échec de l’opération.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

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

Scopes

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

Exemples

WorkspacesCreate

Sample Request

PUT 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
  },
  "location": "australiasoutheast",
  "tags": {
    "tag1": "val1"
  }
}

Sample Response

Status code:
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"
  }
}
Status code:
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"
  }
}
Status code:
202

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

Status d’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

Référence de ressource d’étendue de liaison privée.
PublicNetworkAccessType

Type d’accès réseau pour fonctionner 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 quotidien pour l’ingestion.
WorkspaceEntityStatus

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

Fonctionnalités de l’espace de travail.
WorkspaceSku

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

Nom de la référence SKU.

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.

Nom Type Description
100

Integer

1000

Integer

10000

Integer

200

Integer

2000

Integer

25000

Integer

300

Integer

400

Integer

500

Integer

5000

Integer

50000

Integer

createdByType

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

Nom Type Description
Application

string

Key

string

ManagedIdentity

string

User

string

DataIngestionStatus

Status d’ingestion de données pour cet espace de travail.

Nom Type Description
ApproachingQuota

string

80 % du quota maximal quotidien atteint.
ForceOff

string

L’ingestion s’est arrêtée suite à la modification du paramètre de service.
ForceOn

string

L’ingestion a commencé suite à la modification du paramètre de service.
OverQuota

string

Atteint le quota de plafond quotidien, l’ingestion a été arrêtée.
RespectQuota

string

Ingestion activée après la réinitialisation du quota de limite quotidienne ou l’activation de l’abonnement.
SubscriptionSuspended

string

L’ingestion a cessé à la suite d’un abonnement suspendu.

ErrorAdditionalInfo

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

Nom Type Description
info

object

Informations supplémentaires
type

string

Type d’informations supplémentaires.

ErrorDetail

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

Réponse d’erreur

Nom Type Description
error

ErrorDetail

Objet d’erreur.

Identity

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 d’utilisateur associées à la ressource. Les références de clé de dictionnaire d’identité utilisateur sont des ID de ressource ARM au format « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ».

IdentityType

Type d’identité de service managé.

Nom Type Description
None

string

SystemAssigned

string

UserAssigned

string

PrivateLinkScopedResource

Référence de 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 d’étendue de liaison privée.

PublicNetworkAccessType

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

Nom Type Description
Disabled

string

Désactive la connectivité publique à Log Analytics via le DNS public.
Enabled

string

Active la connectivité à Log Analytics via le DNS public.

systemData

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

Nom Type Description
createdAt

string

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

Horodatage de la dernière modification de la ressource (UTC)
lastModifiedBy

string

Identité qui a modifié la dernière ressource.
lastModifiedByType

createdByType

Type d’identité qui a modifié la dernière ressource.

UserIdentityProperties

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

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 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. Format attendu : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionRules/{dcrName}.
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 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.retentionInDays

integer

Conservation des données de l’espace de travail en jours. Les valeurs autorisées sont par plan tarifaire. Pour plus d’informations, consultez la documentation relative aux niveaux tarifaires.
properties.sku

WorkspaceSku

Référence SKU de l’espace de travail.
properties.workspaceCapping

WorkspaceCapping

Limite de volume quotidien 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

Limite de volume quotidien pour l’ingestion.

Nom Type Description
dailyQuotaGb

number

Quota quotidien de l’espace de travail pour l’ingestion.
dataIngestionStatus

DataIngestionStatus

Status d’ingestion de données pour cet espace de travail.
quotaNextResetTime

string

Heure à laquelle le quota sera reposé.

WorkspaceEntityStatus

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

Nom Type Description
Canceled

string

Creating

string

Deleting

string

Failed

string

ProvisioningAccount

string

Succeeded

string

Updating

string

WorkspaceFeatures

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 qui indique si les données doivent être exportées.
enableLogAccessUsingOnlyResourcePermissions

boolean

Indicateur qui indique l’autorisation à 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

Indique si l’espace de travail de spécification est limité au modèle de facturation unifié de sentinel uniquement.

WorkspaceSku

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

Nom Type Description
capacityReservationLevel

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

string

Dernière mise à jour de la référence sku.
name

WorkspaceSkuNameEnum

Nom de la référence SKU.

WorkspaceSkuNameEnum

Nom de la référence SKU.

Nom Type Description
CapacityReservation

string

Free

string

LACluster

string

PerGB2018

string

PerNode

string

Premium

string

Standalone

string

Standard

string