Diagnostic Settings - Create Or Update

Služba:

Monitor

Verze rozhraní API:

2021-05-01-preview

Vytvoří nebo aktualizuje nastavení diagnostiky pro zadaný prostředek.

PUT https://management.azure.com/{resourceUri}/providers/Microsoft.Insights/diagnosticSettings/{name}?api-version=2021-05-01-preview

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
name	path	True	string	Název nastavení diagnostiky.
resourceUri	path	True	string	Identifikátor prostředku.
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.

Text požadavku

Name	Typ	Description
properties.eventHubAuthorizationRuleId	string	ID prostředku pro autorizační pravidlo centra událostí.
properties.eventHubName	string	Název centra událostí. Pokud není zadán žádný, vybere se výchozí centrum událostí.
properties.logAnalyticsDestinationType	string	Řetězec označující, jestli má export do Log Analytics používat výchozí cílový typ, tj. AzureDiagnostics, nebo použít cílový typ vytvořený následujícím způsobem: _. Možné hodnoty jsou: Dedicated a null (hodnota null je výchozí.)
properties.logs	LogSettings[]	Seznam nastavení protokolů.
properties.marketplacePartnerId	string	Úplné ID prostředku ARM prostředku Marketplace, do kterého chcete odesílat diagnostické protokoly.
properties.metrics	MetricSettings[]	Seznam nastavení metrik
properties.serviceBusRuleId	string	ID pravidla služby Service Bus pro nastavení diagnostiky. Tady je zachování zpětné kompatibility.
properties.storageAccountId	string	ID prostředku účtu úložiště, do kterého chcete odesílat diagnostické protokoly.
properties.workspaceId	string	Úplné ID prostředku ARM pracovního prostoru služby Log Analytics, do kterého chcete odesílat diagnostické protokoly. Příklad: /subscriptions/4b9e8510-67ab-4e9a-95a9-e2f1e570ea9c/resourceGroups/insights-integration/providers/Microsoft.OperationalInsights/workspaces/viruela2

Odpovědi

Name	Typ	Description
200 OK	DiagnosticSettingsResource	Úspěšná žádost o vytvoření nastavení diagnostiky
Other Status Codes	ErrorResponse	Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

Creates or Updates the diagnostic setting

Creates or Updates the diagnostic setting for category

Creates or Updates the diagnostic setting

Ukázkový požadavek

HTTP

PUT https://management.azure.com/subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourcegroups/viruela1/providers/microsoft.logic/workflows/viruela6/providers/Microsoft.Insights/diagnosticSettings/mysetting?api-version=2021-05-01-preview

{
  "properties": {
    "storageAccountId": "/subscriptions/df602c9c-7aa0-407d-a6fb-eb20c8bd1192/resourceGroups/apptest/providers/Microsoft.Storage/storageAccounts/appteststorage1",
    "workspaceId": "",
    "eventHubAuthorizationRuleId": "/subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourceGroups/montest/providers/microsoft.eventhub/namespaces/mynamespace/authorizationrules/myrule",
    "eventHubName": "myeventhub",
    "marketplacePartnerId": "/subscriptions/abcdeabc-1234-1234-ab12-123a1234567a/resourceGroups/test-rg/providers/Microsoft.Datadog/monitors/dd1",
    "metrics": [
      {
        "category": "WorkflowMetrics",
        "enabled": true,
        "retentionPolicy": {
          "enabled": false,
          "days": 0
        }
      }
    ],
    "logs": [
      {
        "categoryGroup": "allLogs",
        "enabled": true,
        "retentionPolicy": {
          "enabled": false,
          "days": 0
        }
      }
    ],
    "logAnalyticsDestinationType": "Dedicated"
  }
}

Java

import com.azure.resourcemanager.monitor.fluent.models.DiagnosticSettingsResourceInner;
import com.azure.resourcemanager.monitor.models.LogSettings;
import com.azure.resourcemanager.monitor.models.MetricSettings;
import com.azure.resourcemanager.monitor.models.RetentionPolicy;
import java.util.Arrays;

/**
 * Samples for DiagnosticSettingsOperation CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/monitor/resource-manager/Microsoft.Insights/preview/2021-05-01-preview/examples/
     * createOrUpdateDiagnosticSetting.json
     */
    /**
     * Sample code: Creates or Updates the diagnostic setting.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void createsOrUpdatesTheDiagnosticSetting(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.diagnosticSettings().manager().serviceClient().getDiagnosticSettingsOperations()
            .createOrUpdateWithResponse(
                "subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourcegroups/viruela1/providers/microsoft.logic/workflows/viruela6",
                "mysetting",
                new DiagnosticSettingsResourceInner().withStorageAccountId(
                    "/subscriptions/df602c9c-7aa0-407d-a6fb-eb20c8bd1192/resourceGroups/apptest/providers/Microsoft.Storage/storageAccounts/appteststorage1")
                    .withEventHubAuthorizationRuleId("fakeTokenPlaceholder").withEventHubName("myeventhub")
                    .withMetrics(Arrays.asList(new MetricSettings().withCategory("WorkflowMetrics").withEnabled(true)
                        .withRetentionPolicy(new RetentionPolicy().withEnabled(false).withDays(0))))
                    .withLogs(Arrays.asList(new LogSettings().withCategoryGroup("allLogs").withEnabled(true)
                        .withRetentionPolicy(new RetentionPolicy().withEnabled(false).withDays(0))))
                    .withWorkspaceId("")
                    .withMarketplacePartnerId(
                        "/subscriptions/abcdeabc-1234-1234-ab12-123a1234567a/resourceGroups/test-rg/providers/Microsoft.Datadog/monitors/dd1")
                    .withLogAnalyticsDestinationType("Dedicated"),
                com.azure.core.util.Context.NONE);
    }
}

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.monitor import MonitorManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-monitor
# USAGE
    python create_or_update_diagnostic_setting.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 = MonitorManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.diagnostic_settings.create_or_update(
        resource_uri="subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourcegroups/viruela1/providers/microsoft.logic/workflows/viruela6",
        name="mysetting",
        parameters={
            "properties": {
                "eventHubAuthorizationRuleId": "/subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourceGroups/montest/providers/microsoft.eventhub/namespaces/mynamespace/authorizationrules/myrule",
                "eventHubName": "myeventhub",
                "logAnalyticsDestinationType": "Dedicated",
                "logs": [
                    {"categoryGroup": "allLogs", "enabled": True, "retentionPolicy": {"days": 0, "enabled": False}}
                ],
                "marketplacePartnerId": "/subscriptions/abcdeabc-1234-1234-ab12-123a1234567a/resourceGroups/test-rg/providers/Microsoft.Datadog/monitors/dd1",
                "metrics": [
                    {"category": "WorkflowMetrics", "enabled": True, "retentionPolicy": {"days": 0, "enabled": False}}
                ],
                "storageAccountId": "/subscriptions/df602c9c-7aa0-407d-a6fb-eb20c8bd1192/resourceGroups/apptest/providers/Microsoft.Storage/storageAccounts/appteststorage1",
                "workspaceId": "",
            }
        },
    )
    print(response)


# x-ms-original-file: specification/monitor/resource-manager/Microsoft.Insights/preview/2021-05-01-preview/examples/createOrUpdateDiagnosticSetting.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 armmonitor_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/monitor/armmonitor"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/969fd0c2634fbcc1975d7abe3749330a5145a97c/specification/monitor/resource-manager/Microsoft.Insights/preview/2021-05-01-preview/examples/createOrUpdateDiagnosticSetting.json
func ExampleDiagnosticSettingsClient_CreateOrUpdate_createsOrUpdatesTheDiagnosticSetting() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armmonitor.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewDiagnosticSettingsClient().CreateOrUpdate(ctx, "subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourcegroups/viruela1/providers/microsoft.logic/workflows/viruela6", "mysetting", armmonitor.DiagnosticSettingsResource{
		Properties: &armmonitor.DiagnosticSettings{
			EventHubAuthorizationRuleID: to.Ptr("/subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourceGroups/montest/providers/microsoft.eventhub/namespaces/mynamespace/authorizationrules/myrule"),
			EventHubName:                to.Ptr("myeventhub"),
			LogAnalyticsDestinationType: to.Ptr("Dedicated"),
			Logs: []*armmonitor.LogSettings{
				{
					CategoryGroup: to.Ptr("allLogs"),
					Enabled:       to.Ptr(true),
					RetentionPolicy: &armmonitor.RetentionPolicy{
						Days:    to.Ptr[int32](0),
						Enabled: to.Ptr(false),
					},
				}},
			MarketplacePartnerID: to.Ptr("/subscriptions/abcdeabc-1234-1234-ab12-123a1234567a/resourceGroups/test-rg/providers/Microsoft.Datadog/monitors/dd1"),
			Metrics: []*armmonitor.MetricSettings{
				{
					Category: to.Ptr("WorkflowMetrics"),
					Enabled:  to.Ptr(true),
					RetentionPolicy: &armmonitor.RetentionPolicy{
						Days:    to.Ptr[int32](0),
						Enabled: to.Ptr(false),
					},
				}},
			StorageAccountID: to.Ptr("/subscriptions/df602c9c-7aa0-407d-a6fb-eb20c8bd1192/resourceGroups/apptest/providers/Microsoft.Storage/storageAccounts/appteststorage1"),
			WorkspaceID:      to.Ptr(""),
		},
	}, 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.DiagnosticSettingsResource = armmonitor.DiagnosticSettingsResource{
	// 	Name: to.Ptr("mysetting"),
	// 	Type: to.Ptr("Microsoft.Insights/diagnosticSettings"),
	// 	ID: to.Ptr("/subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourcegroups/viruela1/providers/microsoft.logic/workflows/viruela6/providers/microsoft.insights/diagnosticSettings/mysetting"),
	// 	Properties: &armmonitor.DiagnosticSettings{
	// 		EventHubAuthorizationRuleID: to.Ptr("/subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourceGroups/montest/providers/microsoft.eventhub/namespaces/mynamespace/authorizationrules/myrule"),
	// 		EventHubName: to.Ptr("myeventhub"),
	// 		LogAnalyticsDestinationType: to.Ptr("Dedicated"),
	// 		Logs: []*armmonitor.LogSettings{
	// 			{
	// 				CategoryGroup: to.Ptr("allLogs"),
	// 				Enabled: to.Ptr(true),
	// 				RetentionPolicy: &armmonitor.RetentionPolicy{
	// 					Days: to.Ptr[int32](0),
	// 					Enabled: to.Ptr(false),
	// 				},
	// 		}},
	// 		MarketplacePartnerID: to.Ptr("/subscriptions/abcdeabc-1234-1234-ab12-123a1234567a/resourceGroups/test-rg/providers/Microsoft.Datadog/monitors/dd1"),
	// 		Metrics: []*armmonitor.MetricSettings{
	// 			{
	// 				Category: to.Ptr("WorkflowMetrics"),
	// 				Enabled: to.Ptr(true),
	// 				RetentionPolicy: &armmonitor.RetentionPolicy{
	// 					Days: to.Ptr[int32](0),
	// 					Enabled: to.Ptr(false),
	// 				},
	// 		}},
	// 		StorageAccountID: to.Ptr("/subscriptions/df602c9c-7aa0-407d-a6fb-eb20c8bd1192/resourceGroups/apptest/providers/Microsoft.Storage/storageAccounts/appteststorage1"),
	// 		WorkspaceID: to.Ptr(""),
	// 	},
	// }
}

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 { MonitorClient } = require("@azure/arm-monitor");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Creates or updates diagnostic settings for the specified resource.
 *
 * @summary Creates or updates diagnostic settings for the specified resource.
 * x-ms-original-file: specification/monitor/resource-manager/Microsoft.Insights/preview/2021-05-01-preview/examples/createOrUpdateDiagnosticSetting.json
 */
async function createsOrUpdatesTheDiagnosticSetting() {
  const resourceUri =
    "subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourcegroups/viruela1/providers/microsoft.logic/workflows/viruela6";
  const name = "mysetting";
  const parameters = {
    eventHubAuthorizationRuleId:
      "/subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourceGroups/montest/providers/microsoft.eventhub/namespaces/mynamespace/authorizationrules/myrule",
    eventHubName: "myeventhub",
    logAnalyticsDestinationType: "Dedicated",
    logs: [
      {
        categoryGroup: "allLogs",
        enabled: true,
        retentionPolicy: { days: 0, enabled: false },
      },
    ],
    marketplacePartnerId:
      "/subscriptions/abcdeabc-1234-1234-ab12-123a1234567a/resourceGroups/test-rg/providers/Microsoft.Datadog/monitors/dd1",
    metrics: [
      {
        category: "WorkflowMetrics",
        enabled: true,
        retentionPolicy: { days: 0, enabled: false },
      },
    ],
    storageAccountId:
      "/subscriptions/df602c9c-7aa0-407d-a6fb-eb20c8bd1192/resourceGroups/apptest/providers/Microsoft.Storage/storageAccounts/appteststorage1",
    workspaceId: "",
  };
  const credential = new DefaultAzureCredential();
  const client = new MonitorClient(credential);
  const result = await client.diagnosticSettings.createOrUpdate(resourceUri, name, 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 Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Monitor.Models;
using Azure.ResourceManager.Monitor;

// Generated from example definition: specification/monitor/resource-manager/Microsoft.Insights/preview/2021-05-01-preview/examples/createOrUpdateDiagnosticSetting.json
// this example is just showing the usage of "DiagnosticSettings_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);

// get the collection of this DiagnosticSettingResource
string resourceUri = "subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourcegroups/viruela1/providers/microsoft.logic/workflows/viruela6";
DiagnosticSettingCollection collection = client.GetDiagnosticSettings(new ResourceIdentifier(resourceUri));

// invoke the operation
string name = "mysetting";
DiagnosticSettingData data = new DiagnosticSettingData
{
    StorageAccountId = new ResourceIdentifier("/subscriptions/df602c9c-7aa0-407d-a6fb-eb20c8bd1192/resourceGroups/apptest/providers/Microsoft.Storage/storageAccounts/appteststorage1"),
    EventHubAuthorizationRuleId = new ResourceIdentifier("/subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourceGroups/montest/providers/microsoft.eventhub/namespaces/mynamespace/authorizationrules/myrule"),
    EventHubName = "myeventhub",
    Metrics = {new MetricSettings(true)
    {
    Category = "WorkflowMetrics",
    RetentionPolicy = new RetentionPolicy(false, 0),
    }},
    Logs = {new LogSettings(true)
    {
    CategoryGroup = "allLogs",
    RetentionPolicy = new RetentionPolicy(false, 0),
    }},
    WorkspaceId = new ResourceIdentifier(""),
    MarketplacePartnerId = new ResourceIdentifier("/subscriptions/abcdeabc-1234-1234-ab12-123a1234567a/resourceGroups/test-rg/providers/Microsoft.Datadog/monitors/dd1"),
    LogAnalyticsDestinationType = "Dedicated",
};
ArmOperation<DiagnosticSettingResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, name, data);
DiagnosticSettingResource 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
DiagnosticSettingData 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

Ukázková odpověď

Stavový kód:

200

{
  "id": "/subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourcegroups/viruela1/providers/microsoft.logic/workflows/viruela6/providers/microsoft.insights/diagnosticSettings/mysetting",
  "type": "Microsoft.Insights/diagnosticSettings",
  "name": "mysetting",
  "properties": {
    "storageAccountId": "/subscriptions/df602c9c-7aa0-407d-a6fb-eb20c8bd1192/resourceGroups/apptest/providers/Microsoft.Storage/storageAccounts/appteststorage1",
    "workspaceId": "",
    "eventHubAuthorizationRuleId": "/subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourceGroups/montest/providers/microsoft.eventhub/namespaces/mynamespace/authorizationrules/myrule",
    "eventHubName": "myeventhub",
    "marketplacePartnerId": "/subscriptions/abcdeabc-1234-1234-ab12-123a1234567a/resourceGroups/test-rg/providers/Microsoft.Datadog/monitors/dd1",
    "metrics": [
      {
        "category": "WorkflowMetrics",
        "enabled": true,
        "retentionPolicy": {
          "enabled": false,
          "days": 0
        }
      }
    ],
    "logs": [
      {
        "categoryGroup": "allLogs",
        "enabled": true,
        "retentionPolicy": {
          "enabled": false,
          "days": 0
        }
      }
    ],
    "logAnalyticsDestinationType": "Dedicated"
  }
}

Creates or Updates the diagnostic setting for category

Ukázkový požadavek

HTTP

PUT https://management.azure.com/subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourcegroups/viruela1/providers/microsoft.logic/workflows/viruela6/providers/Microsoft.Insights/diagnosticSettings/mysetting?api-version=2021-05-01-preview

{
  "properties": {
    "storageAccountId": "/subscriptions/df602c9c-7aa0-407d-a6fb-eb20c8bd1192/resourceGroups/apptest/providers/Microsoft.Storage/storageAccounts/appteststorage1",
    "workspaceId": "",
    "eventHubAuthorizationRuleId": "/subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourceGroups/montest/providers/microsoft.eventhub/namespaces/mynamespace/authorizationrules/myrule",
    "eventHubName": "myeventhub",
    "marketplacePartnerId": "/subscriptions/abcdeabc-1234-1234-ab12-123a1234567a/resourceGroups/test-rg/providers/Microsoft.Datadog/monitors/dd1",
    "metrics": [
      {
        "category": "WorkflowMetrics",
        "enabled": true,
        "retentionPolicy": {
          "enabled": false,
          "days": 0
        }
      }
    ],
    "logs": [
      {
        "category": "WorkflowRuntime",
        "enabled": true,
        "retentionPolicy": {
          "enabled": false,
          "days": 0
        }
      }
    ],
    "logAnalyticsDestinationType": "Dedicated"
  }
}

Java

import com.azure.resourcemanager.monitor.fluent.models.DiagnosticSettingsResourceInner;
import com.azure.resourcemanager.monitor.models.LogSettings;
import com.azure.resourcemanager.monitor.models.MetricSettings;
import com.azure.resourcemanager.monitor.models.RetentionPolicy;
import java.util.Arrays;

/**
 * Samples for DiagnosticSettingsOperation CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/monitor/resource-manager/Microsoft.Insights/preview/2021-05-01-preview/examples/
     * createOrUpdateDiagnosticSettingCategory.json
     */
    /**
     * Sample code: Creates or Updates the diagnostic setting for category.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        createsOrUpdatesTheDiagnosticSettingForCategory(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.diagnosticSettings().manager().serviceClient().getDiagnosticSettingsOperations()
            .createOrUpdateWithResponse(
                "subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourcegroups/viruela1/providers/microsoft.logic/workflows/viruela6",
                "mysetting",
                new DiagnosticSettingsResourceInner().withStorageAccountId(
                    "/subscriptions/df602c9c-7aa0-407d-a6fb-eb20c8bd1192/resourceGroups/apptest/providers/Microsoft.Storage/storageAccounts/appteststorage1")
                    .withEventHubAuthorizationRuleId("fakeTokenPlaceholder").withEventHubName("myeventhub")
                    .withMetrics(Arrays.asList(new MetricSettings().withCategory("WorkflowMetrics").withEnabled(true)
                        .withRetentionPolicy(new RetentionPolicy().withEnabled(false).withDays(0))))
                    .withLogs(Arrays.asList(new LogSettings().withCategory("WorkflowRuntime").withEnabled(true)
                        .withRetentionPolicy(new RetentionPolicy().withEnabled(false).withDays(0))))
                    .withWorkspaceId("")
                    .withMarketplacePartnerId(
                        "/subscriptions/abcdeabc-1234-1234-ab12-123a1234567a/resourceGroups/test-rg/providers/Microsoft.Datadog/monitors/dd1")
                    .withLogAnalyticsDestinationType("Dedicated"),
                com.azure.core.util.Context.NONE);
    }
}

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.monitor import MonitorManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-monitor
# USAGE
    python create_or_update_diagnostic_setting_category.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 = MonitorManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.diagnostic_settings.create_or_update(
        resource_uri="subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourcegroups/viruela1/providers/microsoft.logic/workflows/viruela6",
        name="mysetting",
        parameters={
            "properties": {
                "eventHubAuthorizationRuleId": "/subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourceGroups/montest/providers/microsoft.eventhub/namespaces/mynamespace/authorizationrules/myrule",
                "eventHubName": "myeventhub",
                "logAnalyticsDestinationType": "Dedicated",
                "logs": [
                    {"category": "WorkflowRuntime", "enabled": True, "retentionPolicy": {"days": 0, "enabled": False}}
                ],
                "marketplacePartnerId": "/subscriptions/abcdeabc-1234-1234-ab12-123a1234567a/resourceGroups/test-rg/providers/Microsoft.Datadog/monitors/dd1",
                "metrics": [
                    {"category": "WorkflowMetrics", "enabled": True, "retentionPolicy": {"days": 0, "enabled": False}}
                ],
                "storageAccountId": "/subscriptions/df602c9c-7aa0-407d-a6fb-eb20c8bd1192/resourceGroups/apptest/providers/Microsoft.Storage/storageAccounts/appteststorage1",
                "workspaceId": "",
            }
        },
    )
    print(response)


# x-ms-original-file: specification/monitor/resource-manager/Microsoft.Insights/preview/2021-05-01-preview/examples/createOrUpdateDiagnosticSettingCategory.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 armmonitor_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/monitor/armmonitor"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/969fd0c2634fbcc1975d7abe3749330a5145a97c/specification/monitor/resource-manager/Microsoft.Insights/preview/2021-05-01-preview/examples/createOrUpdateDiagnosticSettingCategory.json
func ExampleDiagnosticSettingsClient_CreateOrUpdate_createsOrUpdatesTheDiagnosticSettingForCategory() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armmonitor.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewDiagnosticSettingsClient().CreateOrUpdate(ctx, "subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourcegroups/viruela1/providers/microsoft.logic/workflows/viruela6", "mysetting", armmonitor.DiagnosticSettingsResource{
		Properties: &armmonitor.DiagnosticSettings{
			EventHubAuthorizationRuleID: to.Ptr("/subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourceGroups/montest/providers/microsoft.eventhub/namespaces/mynamespace/authorizationrules/myrule"),
			EventHubName:                to.Ptr("myeventhub"),
			LogAnalyticsDestinationType: to.Ptr("Dedicated"),
			Logs: []*armmonitor.LogSettings{
				{
					Category: to.Ptr("WorkflowRuntime"),
					Enabled:  to.Ptr(true),
					RetentionPolicy: &armmonitor.RetentionPolicy{
						Days:    to.Ptr[int32](0),
						Enabled: to.Ptr(false),
					},
				}},
			MarketplacePartnerID: to.Ptr("/subscriptions/abcdeabc-1234-1234-ab12-123a1234567a/resourceGroups/test-rg/providers/Microsoft.Datadog/monitors/dd1"),
			Metrics: []*armmonitor.MetricSettings{
				{
					Category: to.Ptr("WorkflowMetrics"),
					Enabled:  to.Ptr(true),
					RetentionPolicy: &armmonitor.RetentionPolicy{
						Days:    to.Ptr[int32](0),
						Enabled: to.Ptr(false),
					},
				}},
			StorageAccountID: to.Ptr("/subscriptions/df602c9c-7aa0-407d-a6fb-eb20c8bd1192/resourceGroups/apptest/providers/Microsoft.Storage/storageAccounts/appteststorage1"),
			WorkspaceID:      to.Ptr(""),
		},
	}, 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.DiagnosticSettingsResource = armmonitor.DiagnosticSettingsResource{
	// 	Name: to.Ptr("mysetting"),
	// 	Type: to.Ptr(""),
	// 	ID: to.Ptr("/subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourcegroups/viruela1/providers/microsoft.logic/workflows/viruela6/diagnosticSettings/mysetting"),
	// 	Properties: &armmonitor.DiagnosticSettings{
	// 		EventHubAuthorizationRuleID: to.Ptr("/subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourceGroups/montest/providers/microsoft.eventhub/namespaces/mynamespace/authorizationrules/myrule"),
	// 		EventHubName: to.Ptr("myeventhub"),
	// 		LogAnalyticsDestinationType: to.Ptr("Dedicated"),
	// 		Logs: []*armmonitor.LogSettings{
	// 			{
	// 				Category: to.Ptr("WorkflowRuntime"),
	// 				Enabled: to.Ptr(true),
	// 				RetentionPolicy: &armmonitor.RetentionPolicy{
	// 					Days: to.Ptr[int32](0),
	// 					Enabled: to.Ptr(false),
	// 				},
	// 		}},
	// 		MarketplacePartnerID: to.Ptr("/subscriptions/abcdeabc-1234-1234-ab12-123a1234567a/resourceGroups/test-rg/providers/Microsoft.Datadog/monitors/dd1"),
	// 		Metrics: []*armmonitor.MetricSettings{
	// 			{
	// 				Category: to.Ptr("WorkflowMetrics"),
	// 				Enabled: to.Ptr(true),
	// 				RetentionPolicy: &armmonitor.RetentionPolicy{
	// 					Days: to.Ptr[int32](0),
	// 					Enabled: to.Ptr(false),
	// 				},
	// 		}},
	// 		StorageAccountID: to.Ptr("/subscriptions/df602c9c-7aa0-407d-a6fb-eb20c8bd1192/resourceGroups/apptest/providers/Microsoft.Storage/storageAccounts/appteststorage1"),
	// 		WorkspaceID: to.Ptr(""),
	// 	},
	// }
}

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 { MonitorClient } = require("@azure/arm-monitor");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Creates or updates diagnostic settings for the specified resource.
 *
 * @summary Creates or updates diagnostic settings for the specified resource.
 * x-ms-original-file: specification/monitor/resource-manager/Microsoft.Insights/preview/2021-05-01-preview/examples/createOrUpdateDiagnosticSettingCategory.json
 */
async function createsOrUpdatesTheDiagnosticSettingForCategory() {
  const resourceUri =
    "subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourcegroups/viruela1/providers/microsoft.logic/workflows/viruela6";
  const name = "mysetting";
  const parameters = {
    eventHubAuthorizationRuleId:
      "/subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourceGroups/montest/providers/microsoft.eventhub/namespaces/mynamespace/authorizationrules/myrule",
    eventHubName: "myeventhub",
    logAnalyticsDestinationType: "Dedicated",
    logs: [
      {
        category: "WorkflowRuntime",
        enabled: true,
        retentionPolicy: { days: 0, enabled: false },
      },
    ],
    marketplacePartnerId:
      "/subscriptions/abcdeabc-1234-1234-ab12-123a1234567a/resourceGroups/test-rg/providers/Microsoft.Datadog/monitors/dd1",
    metrics: [
      {
        category: "WorkflowMetrics",
        enabled: true,
        retentionPolicy: { days: 0, enabled: false },
      },
    ],
    storageAccountId:
      "/subscriptions/df602c9c-7aa0-407d-a6fb-eb20c8bd1192/resourceGroups/apptest/providers/Microsoft.Storage/storageAccounts/appteststorage1",
    workspaceId: "",
  };
  const credential = new DefaultAzureCredential();
  const client = new MonitorClient(credential);
  const result = await client.diagnosticSettings.createOrUpdate(resourceUri, name, 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 Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Monitor.Models;
using Azure.ResourceManager.Monitor;

// Generated from example definition: specification/monitor/resource-manager/Microsoft.Insights/preview/2021-05-01-preview/examples/createOrUpdateDiagnosticSettingCategory.json
// this example is just showing the usage of "DiagnosticSettings_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);

// get the collection of this DiagnosticSettingResource
string resourceUri = "subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourcegroups/viruela1/providers/microsoft.logic/workflows/viruela6";
DiagnosticSettingCollection collection = client.GetDiagnosticSettings(new ResourceIdentifier(resourceUri));

// invoke the operation
string name = "mysetting";
DiagnosticSettingData data = new DiagnosticSettingData
{
    StorageAccountId = new ResourceIdentifier("/subscriptions/df602c9c-7aa0-407d-a6fb-eb20c8bd1192/resourceGroups/apptest/providers/Microsoft.Storage/storageAccounts/appteststorage1"),
    EventHubAuthorizationRuleId = new ResourceIdentifier("/subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourceGroups/montest/providers/microsoft.eventhub/namespaces/mynamespace/authorizationrules/myrule"),
    EventHubName = "myeventhub",
    Metrics = {new MetricSettings(true)
    {
    Category = "WorkflowMetrics",
    RetentionPolicy = new RetentionPolicy(false, 0),
    }},
    Logs = {new LogSettings(true)
    {
    Category = "WorkflowRuntime",
    RetentionPolicy = new RetentionPolicy(false, 0),
    }},
    WorkspaceId = new ResourceIdentifier(""),
    MarketplacePartnerId = new ResourceIdentifier("/subscriptions/abcdeabc-1234-1234-ab12-123a1234567a/resourceGroups/test-rg/providers/Microsoft.Datadog/monitors/dd1"),
    LogAnalyticsDestinationType = "Dedicated",
};
ArmOperation<DiagnosticSettingResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, name, data);
DiagnosticSettingResource 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
DiagnosticSettingData 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

Ukázková odpověď

Stavový kód:

200

{
  "id": "/subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourcegroups/viruela1/providers/microsoft.logic/workflows/viruela6/diagnosticSettings/mysetting",
  "type": "",
  "name": "mysetting",
  "properties": {
    "storageAccountId": "/subscriptions/df602c9c-7aa0-407d-a6fb-eb20c8bd1192/resourceGroups/apptest/providers/Microsoft.Storage/storageAccounts/appteststorage1",
    "workspaceId": "",
    "eventHubAuthorizationRuleId": "/subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourceGroups/montest/providers/microsoft.eventhub/namespaces/mynamespace/authorizationrules/myrule",
    "eventHubName": "myeventhub",
    "marketplacePartnerId": "/subscriptions/abcdeabc-1234-1234-ab12-123a1234567a/resourceGroups/test-rg/providers/Microsoft.Datadog/monitors/dd1",
    "metrics": [
      {
        "category": "WorkflowMetrics",
        "enabled": true,
        "retentionPolicy": {
          "enabled": false,
          "days": 0
        }
      }
    ],
    "logs": [
      {
        "category": "WorkflowRuntime",
        "enabled": true,
        "retentionPolicy": {
          "enabled": false,
          "days": 0
        }
      }
    ],
    "logAnalyticsDestinationType": "Dedicated"
  }
}

Definice

Name	Description
createdByType	Typ identity, která prostředek vytvořila.
DiagnosticSettingsResource	Prostředek nastavení diagnostiky.
ErrorResponse	Popisuje formát odpovědi na chybu.
LogSettings	Součást MultiTenantDiagnosticSettings. Určuje nastavení konkrétního protokolu.
MetricSettings	Součást MultiTenantDiagnosticSettings. Určuje nastavení konkrétní metriky.
RetentionPolicy	Určuje zásady uchovávání informací pro protokol.
systemData	Metadata týkající se vytvoření a poslední změny prostředku.

createdByType

Výčet

Typ identity, která prostředek vytvořila.

Hodnota	Description
Application
Key
ManagedIdentity
User

DiagnosticSettingsResource

Objekt

Prostředek nastavení diagnostiky.

Name	Typ	Description
id	string	Plně kvalifikované ID prostředku pro prostředek. Příklad : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Název prostředku
properties.eventHubAuthorizationRuleId	string	ID prostředku pro autorizační pravidlo centra událostí.
properties.eventHubName	string	Název centra událostí. Pokud není zadán žádný, vybere se výchozí centrum událostí.
properties.logAnalyticsDestinationType	string	Řetězec označující, jestli má export do Log Analytics používat výchozí cílový typ, tj. AzureDiagnostics, nebo použít cílový typ vytvořený následujícím způsobem: _. Možné hodnoty jsou: Dedicated a null (hodnota null je výchozí.)
properties.logs	LogSettings[]	Seznam nastavení protokolů.
properties.marketplacePartnerId	string	Úplné ID prostředku ARM prostředku Marketplace, do kterého chcete odesílat diagnostické protokoly.
properties.metrics	MetricSettings[]	Seznam nastavení metrik
properties.serviceBusRuleId	string	ID pravidla služby Service Bus pro nastavení diagnostiky. Tady je zachování zpětné kompatibility.
properties.storageAccountId	string	ID prostředku účtu úložiště, do kterého chcete odesílat diagnostické protokoly.
properties.workspaceId	string	Úplné ID prostředku ARM pracovního prostoru služby Log Analytics, do kterého chcete odesílat diagnostické protokoly. Příklad: /subscriptions/4b9e8510-67ab-4e9a-95a9-e2f1e570ea9c/resourceGroups/insights-integration/providers/Microsoft.OperationalInsights/workspaces/viruela2
systemData	systemData	Systémová metadata související s tímto prostředkem.
type	string	Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

ErrorResponse

Objekt

Popisuje formát odpovědi na chybu.

Name	Typ	Description
code	string	Kód chyby
message	string	Chybová zpráva označující, proč operace selhala.

LogSettings

Objekt

Součást MultiTenantDiagnosticSettings. Určuje nastavení konkrétního protokolu.

Name	Typ	Description
category	string	Název kategorie diagnostického protokolu pro typ prostředku, na který se toto nastavení vztahuje. Pokud chcete získat seznam kategorií diagnostických protokolů pro prostředek, nejprve proveďte operaci nastavení diagnostiky GET.
categoryGroup	string	Název skupiny kategorií diagnostického protokolu pro typ prostředku, na který se toto nastavení vztahuje. Pokud chcete získat seznam kategorií diagnostických protokolů pro prostředek, nejprve proveďte operaci nastavení diagnostiky GET.
enabled	boolean	hodnota označující, jestli je tento protokol povolený.
retentionPolicy	RetentionPolicy	zásady uchovávání informací pro tento protokol.

MetricSettings

Objekt

Součást MultiTenantDiagnosticSettings. Určuje nastavení konkrétní metriky.

Name	Typ	Description
category	string	Název kategorie Diagnostická metrika pro typ prostředku, na který se toto nastavení vztahuje. Pokud chcete získat seznam kategorií diagnostických metrik pro prostředek, nejprve proveďte operaci nastavení diagnostiky GET.
enabled	boolean	hodnota označující, zda je tato kategorie povolena.
retentionPolicy	RetentionPolicy	zásady uchovávání informací pro tuto kategorii.
timeGrain	string (duration)	časové měřítko metriky ve formátu ISO8601.

RetentionPolicy

Objekt

Určuje zásady uchovávání informací pro protokol.

Name	Typ	Description
days	integer (int32) minimum: 0	počet dnů uchovávání ve dnech. Hodnota 0 zachová události po neomezenou dobu.
enabled	boolean	hodnota označující, jestli je zásada uchovávání informací povolená.

systemData

Objekt

Metadata týkající se vytvoření a poslední změny prostředku.

Name	Typ	Description
createdAt	string (date-time)	Časové razítko vytvoření prostředku (UTC).
createdBy	string	Identita, která prostředek vytvořila.
createdByType	createdByType	Typ identity, která prostředek vytvořila.
lastModifiedAt	string (date-time)	Časové razítko poslední změny zdroje (UTC)
lastModifiedBy	string	Identita, která naposledy změnila prostředek.
lastModifiedByType	createdByType	Typ identity, která naposledy změnila prostředek.