Data Sources - Create Or Update

Service:

Log Analytics

API Version:

2020-08-01

データ ソースを作成または更新します。

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

URI パラメーター

名前	/	必須	型	説明
dataSourceName	path	True	string	データソース リソースの名前。
resourceGroupName	path	True	string	リソース グループの名前。 名前の大文字と小文字は区別されます。
subscriptionId	path	True	string	ターゲット サブスクリプションの ID。
workspaceName	path	True	string	ワークスペースの名前。 Regex pattern: ^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$
api-version	query	True	string	この操作に使用する API バージョン。

要求本文

名前	必須	型	説明
kind	True	DataSourceKind	DataSource の種類。
properties	True	Object	生の json 形式のデータ ソース プロパティは、データ ソースの種類ごとに独自のスキーマを持ちます。
etag		string	データ ソースの ETag。
tags		object	リソース タグ。

応答

名前	型	説明
200 OK	DataSource	OK 応答の定義。
201 Created	DataSource	応答定義を作成しました。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

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

Scopes

名前	説明
user_impersonation	ユーザー アカウントの借用

例

DataSourcesCreate

Sample Request

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-00000000000/resourcegroups/OIAutoRest5123/providers/Microsoft.OperationalInsights/workspaces/AzTest9724/dataSources/AzTestDS774?api-version=2020-08-01

{
  "properties": {
    "LinkedResourceId": "/subscriptions/00000000-0000-0000-0000-00000000000/providers/microsoft.insights/eventtypes/management"
  },
  "kind": "AzureActivityLog"
}

Java

import com.azure.core.management.serializer.SerializerFactory;
import com.azure.core.util.serializer.SerializerEncoding;
import com.azure.resourcemanager.loganalytics.models.DataSourceKind;
import java.io.IOException;

/** Samples for DataSources CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file: specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2020-08-01/examples/DataSourcesCreate.json
     */
    /**
     * Sample code: DataSourcesCreate.
     *
     * @param manager Entry point to LogAnalyticsManager.
     */
    public static void dataSourcesCreate(com.azure.resourcemanager.loganalytics.LogAnalyticsManager manager)
        throws IOException {
        manager
            .dataSources()
            .define("AzTestDS774")
            .withExistingWorkspace("OIAutoRest5123", "AzTest9724")
            .withProperties(
                SerializerFactory
                    .createDefaultManagementSerializerAdapter()
                    .deserialize(
                        "{\"LinkedResourceId\":\"/subscriptions/00000000-0000-0000-0000-00000000000/providers/microsoft.insights/eventtypes/management\"}",
                        Object.class,
                        SerializerEncoding.JSON))
            .withKind(DataSourceKind.AZURE_ACTIVITY_LOG)
            .create();
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.loganalytics import LogAnalyticsManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-loganalytics
# USAGE
    python data_sources_create.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = LogAnalyticsManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-0000-0000-0000-00000000000",
    )

    response = client.data_sources.create_or_update(
        resource_group_name="OIAutoRest5123",
        workspace_name="AzTest9724",
        data_source_name="AzTestDS774",
        parameters={
            "kind": "AzureActivityLog",
            "properties": {
                "LinkedResourceId": "/subscriptions/00000000-0000-0000-0000-00000000000/providers/microsoft.insights/eventtypes/management"
            },
        },
    )
    print(response)


# x-ms-original-file: specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2020-08-01/examples/DataSourcesCreate.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armoperationalinsights_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/operationalinsights/armoperationalinsights"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c767823fdfd9d5e96bad245e3ea4d14d94a716bb/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2020-08-01/examples/DataSourcesCreate.json
func ExampleDataSourcesClient_CreateOrUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armoperationalinsights.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewDataSourcesClient().CreateOrUpdate(ctx, "OIAutoRest5123", "AzTest9724", "AzTestDS774", armoperationalinsights.DataSource{
		Kind: to.Ptr(armoperationalinsights.DataSourceKindAzureActivityLog),
		Properties: map[string]any{
			"LinkedResourceId": "/subscriptions/00000000-0000-0000-0000-00000000000/providers/microsoft.insights/eventtypes/management",
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.DataSource = armoperationalinsights.DataSource{
	// 	Name: to.Ptr("AzTestDS774"),
	// 	Type: to.Ptr("Microsoft.OperationalInsights/workspaces/datasources"),
	// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest5123/providers/Microsoft.OperationalInsights/workspaces/AzTest9724/datasources/AzTestDS774"),
	// 	Etag: to.Ptr("W/\"datetime'2017-10-01T08%3A01%3A21.2351243Z'\""),
	// 	Kind: to.Ptr(armoperationalinsights.DataSourceKindAzureActivityLog),
	// 	Properties: map[string]any{
	// 		"linkedResourceId": "/subscriptions/00000000-0000-0000-0000-00000000000/providers/microsoft.insights/eventtypes/management",
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { OperationalInsightsManagementClient } = require("@azure/arm-operationalinsights");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Create or update a data source.
 *
 * @summary Create or update a data source.
 * x-ms-original-file: specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2020-08-01/examples/DataSourcesCreate.json
 */
async function dataSourcesCreate() {
  const subscriptionId =
    process.env["OPERATIONALINSIGHTS_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-00000000000";
  const resourceGroupName = process.env["OPERATIONALINSIGHTS_RESOURCE_GROUP"] || "OIAutoRest5123";
  const workspaceName = "AzTest9724";
  const dataSourceName = "AzTestDS774";
  const parameters = {
    kind: "AzureActivityLog",
    properties: {
      LinkedResourceId:
        "/subscriptions/00000000-0000-0000-0000-00000000000/providers/microsoft.insights/eventtypes/management",
    },
  };
  const credential = new DefaultAzureCredential();
  const client = new OperationalInsightsManagementClient(credential, subscriptionId);
  const result = await client.dataSources.createOrUpdate(
    resourceGroupName,
    workspaceName,
    dataSourceName,
    parameters
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.OperationalInsights;
using Azure.ResourceManager.OperationalInsights.Models;

// Generated from example definition: specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2020-08-01/examples/DataSourcesCreate.json
// this example is just showing the usage of "DataSources_CreateOrUpdate" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this OperationalInsightsDataSourceResource created on azure
// for more information of creating OperationalInsightsDataSourceResource, please refer to the document of OperationalInsightsDataSourceResource
string subscriptionId = "00000000-0000-0000-0000-00000000000";
string resourceGroupName = "OIAutoRest5123";
string workspaceName = "AzTest9724";
string dataSourceName = "AzTestDS774";
ResourceIdentifier operationalInsightsDataSourceResourceId = OperationalInsightsDataSourceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, workspaceName, dataSourceName);
OperationalInsightsDataSourceResource operationalInsightsDataSource = client.GetOperationalInsightsDataSourceResource(operationalInsightsDataSourceResourceId);

// invoke the operation
OperationalInsightsDataSourceData data = new OperationalInsightsDataSourceData(BinaryData.FromObjectAsJson(new Dictionary<string, object>()
{
    ["LinkedResourceId"] = "/subscriptions/00000000-0000-0000-0000-00000000000/providers/microsoft.insights/eventtypes/management"
}), OperationalInsightsDataSourceKind.AzureActivityLog);
ArmOperation<OperationalInsightsDataSourceResource> lro = await operationalInsightsDataSource.UpdateAsync(WaitUntil.Completed, data);
OperationalInsightsDataSourceResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
OperationalInsightsDataSourceData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

200

{
  "kind": "AzureActivityLog",
  "properties": {
    "linkedResourceId": "/subscriptions/00000000-0000-0000-0000-00000000000/providers/microsoft.insights/eventtypes/management"
  },
  "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest5123/providers/Microsoft.OperationalInsights/workspaces/AzTest9724/datasources/AzTestDS774",
  "etag": "W/\"datetime'2017-10-01T08%3A01%3A21.2351243Z'\"",
  "name": "AzTestDS774",
  "type": "Microsoft.OperationalInsights/workspaces/datasources"
}

Status code:

201

{
  "kind": "AzureActivityLog",
  "properties": {
    "linkedResourceId": "/subscriptions/00000000-0000-0000-0000-00000000000/providers/microsoft.insights/eventtypes/management"
  },
  "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest5123/providers/Microsoft.OperationalInsights/workspaces/AzTest9724/datasources/AzTestDS774",
  "etag": "W/\"datetime'2017-10-01T08%3A01%3A21.2351243Z'\"",
  "name": "AzTestDS774",
  "type": "Microsoft.OperationalInsights/workspaces/datasources"
}

定義

名前	説明
DataSource	OMS ワークスペースのデータソース。
DataSourceKind	DataSource の種類。
Object	JSON オブジェクト

DataSource

OMS ワークスペースのデータソース。

名前	型	説明
etag	string	データ ソースの ETag。
id	string	リソースの完全修飾リソース ID。 例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
kind	DataSourceKind	DataSource の種類。
name	string	リソースの名前
properties	Object	生の json 形式のデータ ソース プロパティは、データ ソースの種類ごとに独自のスキーマを持ちます。
tags	object	リソース タグ。
type	string	リソースの型。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

DataSourceKind

DataSource の種類。

名前	型	説明
ApplicationInsights	string
AzureActivityLog	string
AzureAuditLog	string
ChangeTrackingContentLocation	string
ChangeTrackingCustomPath	string
ChangeTrackingDataTypeConfiguration	string
ChangeTrackingDefaultRegistry	string
ChangeTrackingLinuxPath	string
ChangeTrackingPath	string
ChangeTrackingRegistry	string
ChangeTrackingServices	string
CustomLog	string
CustomLogCollection	string
DnsAnalytics	string
GenericDataSource	string
IISLogs	string
ImportComputerGroup	string
Itsm	string
LinuxChangeTrackingPath	string
LinuxPerformanceCollection	string
LinuxPerformanceObject	string
LinuxSyslog	string
LinuxSyslogCollection	string
NetworkMonitoring	string
Office365	string
SecurityCenterSecurityWindowsBaselineConfiguration	string
SecurityEventCollectionConfiguration	string
SecurityInsightsSecurityEventCollectionConfiguration	string
SecurityWindowsBaselineConfiguration	string
SqlDataClassification	string
WindowsEvent	string
WindowsPerformanceCounter	string
WindowsTelemetry	string

Object

JSON オブジェクト