Data Exports - Create Or Update

Başvuru

Service:: Log Analytics

API Version:: 2020-08-01

Veri dışarı aktarmayı oluşturun veya güncelleştirin.

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
dataExportName	path	True	string	Veri dışarı aktarma kuralı adı. Regex pattern: `^[A-Za-z][A-Za-z0-9-]+[A-Za-z0-9]$`
resourceGroupName	path	True	string	Kaynak grubunun adı. Ad büyük/küçük harfe duyarlı değildir.
subscriptionId	path	True	string	Hedef aboneliğin kimliği.
workspaceName	path	True	string	Çalışma alanının adı. Regex pattern: `^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$`
api-version	query	True	string	Bu işlem için kullanılacak API sürümü.

İstek Gövdesi

Name	Gerekli	Tür	Description
properties.destination.resourceId	True	string	Hedef kaynak kimliği. Bu, Azure'daki hedef kaynağın Özellikler girdisinden kopyalanabilir.
properties.tableNames	True	string[]	Dışarı aktaracak bir tablo dizisi, örneğin: ["Heartbeat, SecurityEvent"].
properties.createdDate		string	En son veri dışarı aktarma kuralı değiştirme zamanı.
properties.dataExportId		string	Veri dışarı aktarma kuralı kimliği.
properties.destination.metaData.eventHubName		string	İsteğe bağlı. Olay Hub'ı adı tanımlamaya izin verir. Hedef Depolama Hesabı olduğunda geçerli değildir.
properties.enable		boolean	Etkinleştirildiğinde etkin.
properties.lastModifiedDate		string	Dışarı aktarma işleminin son değiştirildiği tarih ve saat.

Yanıtlar

Name	Tür	Description
200 OK	DataExport	Tamam yanıt tanımı.
201 Created	DataExport	Yanıt tanımı oluşturuldu.
Other Status Codes	ErrorResponse	İşlemin neden başarısız olduğunu açıklayan hata yanıtı.

Güvenlik

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name	Description
user_impersonation	kullanıcı hesabınızın kimliğine bürünme

Örnekler

DataExportCreate

Sample Request

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-00000000000/resourcegroups/RgTest1/providers/Microsoft.OperationalInsights/workspaces/DeWnTest1234/dataExports/export1?api-version=2020-08-01

{
  "properties": {
    "destination": {
      "resourceId": "/subscriptions/192b9f85-a39a-4276-b96d-d5cd351703f9/resourceGroups/OIAutoRest1234/providers/Microsoft.EventHub/namespaces/test"
    },
    "tableNames": [
      "Heartbeat"
    ]
  }
}

import java.util.Arrays;

/** Samples for DataExports CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file: specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2020-08-01/examples/DataExportCreateOrUpdate.json
     */
    /**
     * Sample code: DataExportCreate.
     *
     * @param manager Entry point to LogAnalyticsManager.
     */
    public static void dataExportCreate(com.azure.resourcemanager.loganalytics.LogAnalyticsManager manager) {
        manager
            .dataExports()
            .define("export1")
            .withExistingWorkspace("RgTest1", "DeWnTest1234")
            .withTableNames(Arrays.asList("Heartbeat"))
            .withResourceId(
                "/subscriptions/192b9f85-a39a-4276-b96d-d5cd351703f9/resourceGroups/OIAutoRest1234/providers/Microsoft.EventHub/namespaces/test")
            .create();
    }
}

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

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

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-loganalytics
# USAGE
    python data_export_create_or_update.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_exports.create_or_update(
        resource_group_name="RgTest1",
        workspace_name="DeWnTest1234",
        data_export_name="export1",
        parameters={
            "properties": {
                "destination": {
                    "resourceId": "/subscriptions/192b9f85-a39a-4276-b96d-d5cd351703f9/resourceGroups/OIAutoRest1234/providers/Microsoft.EventHub/namespaces/test"
                },
                "tableNames": ["Heartbeat"],
            }
        },
    )
    print(response)


# x-ms-original-file: specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2020-08-01/examples/DataExportCreateOrUpdate.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

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/DataExportCreateOrUpdate.json
func ExampleDataExportsClient_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.NewDataExportsClient().CreateOrUpdate(ctx, "RgTest1", "DeWnTest1234", "export1", armoperationalinsights.DataExport{
		Properties: &armoperationalinsights.DataExportProperties{
			Destination: &armoperationalinsights.Destination{
				ResourceID: to.Ptr("/subscriptions/192b9f85-a39a-4276-b96d-d5cd351703f9/resourceGroups/OIAutoRest1234/providers/Microsoft.EventHub/namespaces/test"),
			},
			TableNames: []*string{
				to.Ptr("Heartbeat")},
		},
	}, 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.DataExport = armoperationalinsights.DataExport{
	// 	Name: to.Ptr("export1"),
	// 	Type: to.Ptr("Microsoft.OperationalInsights/workspaces/export"),
	// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-00000000000/resourcegroups/RgTest1/providers/microsoft.operationalinsights/workspaces/DeWnTest1234/export/export1"),
	// 	Properties: &armoperationalinsights.DataExportProperties{
	// 		CreatedDate: to.Ptr("Sun, 12 Jan 2020 12:51:10 GMT"),
	// 		DataExportID: to.Ptr("d5233afc-7829-4b89-c594-08d7975e19a5"),
	// 		Destination: &armoperationalinsights.Destination{
	// 			Type: to.Ptr(armoperationalinsights.TypeEventHub),
	// 			ResourceID: to.Ptr("/subscriptions/192b9f85-a39a-4276-b96d-d5cd351703f9/resourceGroups/OIAutoRest1234/providers/Microsoft.EventHub/namespaces/test"),
	// 		},
	// 		Enable: to.Ptr(true),
	// 		LastModifiedDate: to.Ptr("Sun, 12 Jan 2020 12:51:10 GMT"),
	// 		TableNames: []*string{
	// 			to.Ptr("Heartbeat")},
	// 		},
	// 	}
}

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

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

/**
 * This sample demonstrates how to Create or update a data export.
 *
 * @summary Create or update a data export.
 * x-ms-original-file: specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2020-08-01/examples/DataExportCreateOrUpdate.json
 */
async function dataExportCreate() {
  const subscriptionId =
    process.env["OPERATIONALINSIGHTS_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-00000000000";
  const resourceGroupName = process.env["OPERATIONALINSIGHTS_RESOURCE_GROUP"] || "RgTest1";
  const workspaceName = "DeWnTest1234";
  const dataExportName = "export1";
  const parameters = {
    resourceId:
      "/subscriptions/192b9f85-a39a-4276-b96d-d5cd351703f9/resourceGroups/OIAutoRest1234/providers/Microsoft.EventHub/namespaces/test",
    tableNames: ["Heartbeat"],
  };
  const credential = new DefaultAzureCredential();
  const client = new OperationalInsightsManagementClient(credential, subscriptionId);
  const result = await client.dataExports.createOrUpdate(
    resourceGroupName,
    workspaceName,
    dataExportName,
    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

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.OperationalInsights;

// Generated from example definition: specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2020-08-01/examples/DataExportCreateOrUpdate.json
// this example is just showing the usage of "DataExports_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 OperationalInsightsWorkspaceResource created on azure
// for more information of creating OperationalInsightsWorkspaceResource, please refer to the document of OperationalInsightsWorkspaceResource
string subscriptionId = "00000000-0000-0000-0000-00000000000";
string resourceGroupName = "RgTest1";
string workspaceName = "DeWnTest1234";
ResourceIdentifier operationalInsightsWorkspaceResourceId = OperationalInsightsWorkspaceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, workspaceName);
OperationalInsightsWorkspaceResource operationalInsightsWorkspace = client.GetOperationalInsightsWorkspaceResource(operationalInsightsWorkspaceResourceId);

// get the collection of this OperationalInsightsDataExportResource
OperationalInsightsDataExportCollection collection = operationalInsightsWorkspace.GetOperationalInsightsDataExports();

// invoke the operation
string dataExportName = "export1";
OperationalInsightsDataExportData data = new OperationalInsightsDataExportData()
{
    TableNames =
    {
    "Heartbeat"
    },
    ResourceId = new ResourceIdentifier("/subscriptions/192b9f85-a39a-4276-b96d-d5cd351703f9/resourceGroups/OIAutoRest1234/providers/Microsoft.EventHub/namespaces/test"),
};
ArmOperation<OperationalInsightsDataExportResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, dataExportName, data);
OperationalInsightsDataExportResource 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
OperationalInsightsDataExportData 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

{
  "properties": {
    "dataExportId": "d5233afc-7829-4b89-c594-08d7975e19a5",
    "destination": {
      "resourceId": "/subscriptions/192b9f85-a39a-4276-b96d-d5cd351703f9/resourceGroups/OIAutoRest1234/providers/Microsoft.EventHub/namespaces/test",
      "type": "EventHub"
    },
    "tableNames": [
      "Heartbeat"
    ],
    "enable": true,
    "createdDate": "Sun, 12 Jan 2020 12:51:10 GMT",
    "lastModifiedDate": "Sun, 12 Jan 2020 12:51:10 GMT"
  },
  "id": "/subscriptions/00000000-0000-0000-0000-00000000000/resourcegroups/RgTest1/providers/microsoft.operationalinsights/workspaces/DeWnTest1234/export/export1",
  "name": "export1",
  "type": "Microsoft.OperationalInsights/workspaces/export"
}

Status code:: 201

{
  "properties": {
    "dataExportId": "d5233afc-7829-4b89-c594-08d7975e19a5",
    "destination": {
      "resourceId": "/subscriptions/192b9f85-a39a-4276-b96d-d5cd351703f9/resourceGroups/OIAutoRest1234/providers/Microsoft.EventHub/namespaces/test",
      "type": "EventHub"
    },
    "tableNames": [
      "Heartbeat"
    ],
    "enable": true,
    "createdDate": "Sun, 12 Jan 2020 12:51:10 GMT",
    "lastModifiedDate": "Sun, 12 Jan 2020 12:51:10 GMT"
  },
  "id": "/subscriptions/00000000-0000-0000-0000-00000000000/resourcegroups/RgTest1/providers/microsoft.operationalinsights/workspaces/DeWnTest1234/export/export1",
  "name": "export1",
  "type": "Microsoft.OperationalInsights/workspaces/export"
}

Tanımlar

Name	Description
DataExport	Üst düzey veri dışarı aktarma kaynak kapsayıcısı.
ErrorAdditionalInfo	Kaynak yönetimi hatası ek bilgileri.
ErrorDetail	Hata ayrıntısı.
ErrorResponse	Hata yanıtı
type	Hedef kaynağın türü

DataExport

Üst düzey veri dışarı aktarma kaynak kapsayıcısı.

Name	Tür	Description
id	string	Kaynağın tam kaynak kimliği. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Kaynağın adı
properties.createdDate	string	En son veri dışarı aktarma kuralı değiştirme zamanı.
properties.dataExportId	string	Veri dışarı aktarma kuralı kimliği.
properties.destination.metaData.eventHubName	string	İsteğe bağlı. Olay Hub'ı adı tanımlamaya izin verir. Hedef Depolama Hesabı olduğunda geçerli değildir.
properties.destination.resourceId	string	Hedef kaynak kimliği. Bu, Azure'daki hedef kaynağın Özellikler girdisinden kopyalanabilir.
properties.destination.type	type	Hedef kaynağın türü
properties.enable	boolean	Etkinleştirildiğinde etkin.
properties.lastModifiedDate	string	Dışarı aktarma işleminin son değiştirildiği tarih ve saat.
properties.tableNames	string[]	Dışarı aktaracak bir tablo dizisi, örneğin: ["Heartbeat, SecurityEvent"].
type	string	Kaynağın türü. Örneğin, "Microsoft.Compute/virtualMachines" veya "Microsoft.Storage/storageAccounts"

ErrorAdditionalInfo

Kaynak yönetimi hatası ek bilgileri.

Name	Tür	Description
info	object	Ek bilgiler.
type	string	Ek bilgi türü.

ErrorDetail

Hata ayrıntısı.

Name	Tür	Description
additionalInfo	ErrorAdditionalInfo[]	Hata ek bilgileri.
code	string	Hata kodu.
details	ErrorDetail[]	Hata ayrıntıları.
message	string	Hata iletisi.
target	string	Hata hedefi.

ErrorResponse

Hata yanıtı

Name	Tür	Description
error	ErrorDetail	Hata nesnesi.

type

Hedef kaynağın türü

Name	Tür	Description
EventHub	string
StorageAccount	string