Log Profiles - Update

Odwołanie

Usługa:: Monitor

Wersja interfejsu API:: 2016-03-01

Aktualizacje istniejącego pliku LogProfilesResource. Aby zaktualizować inne pola, użyj metody CreateOrUpdate.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Insights/logprofiles/{logProfileName}?api-version=2016-03-01

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
logProfileName	path	True	string	Nazwa profilu dziennika.
subscriptionId	path	True	string	Identyfikator subskrypcji docelowej.
api-version	query	True	string	Wersja interfejsu API do użycia dla tej operacji.

Treść żądania

Nazwa	Wymagane	Typ	Opis
properties.categories	True	string[]	kategorie dzienników. Te kategorie są tworzone jako wygodne dla użytkownika. Niektóre wartości to: "Write", "Delete" i/or "Action".
properties.locations	True	string[]	Lista regionów, dla których powinny być przechowywane lub przesyłane strumieniowo zdarzenia dziennika aktywności. Jest to rozdzielona przecinkami lista prawidłowych lokalizacji usługi ARM, w tym lokalizacja "globalna".
properties.retentionPolicy	True	RetentionPolicy	zasady przechowywania zdarzeń w dzienniku.
properties.serviceBusRuleId		string	Identyfikator reguły magistrali usług dla przestrzeni nazw usługi Service Bus, w której chcesz mieć usługę Event Hubs utworzoną do przesyłania strumieniowego dziennika aktywności. Identyfikator reguły ma format: "{identyfikator zasobu usługi Service Bus}/authorizationrules/{nazwa klucza}".
properties.storageAccountId		string	identyfikator zasobu konta magazynu, do którego chcesz wysłać dziennik aktywności.
tags		object	Tagi zasobów

Odpowiedzi

Nazwa	Typ	Opis
200 OK	LogProfileResource	Istniejący profil dziennika został pomyślnie zaktualizowany.
Other Status Codes	ErrorResponse	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

Patch a log profile

Przykładowe żądanie

PATCH https://management.azure.com/subscriptions/df602c9c-7aa0-407d-a6fb-eb20c8bd1192/providers/Microsoft.Insights/logprofiles/Rac46PostSwapRG?api-version=2016-03-01

{
  "tags": {
    "key1": "value1"
  },
  "properties": {
    "locations": [
      "global"
    ],
    "categories": [
      "Write",
      "Delete",
      "Action"
    ],
    "retentionPolicy": {
      "enabled": true,
      "days": 3
    },
    "storageAccountId": "/subscriptions/df602c9c-7aa0-407d-a6fb-eb20c8bd1192/resourceGroups/JohnKemTest/providers/Microsoft.Storage/storageAccounts/johnkemtest8162",
    "serviceBusRuleId": ""
  }
}


import com.azure.resourcemanager.monitor.models.LogProfileResourcePatch;
import com.azure.resourcemanager.monitor.models.RetentionPolicy;
import java.util.Arrays;
import java.util.HashMap;
import java.util.Map;

/**
 * Samples for LogProfiles Update.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/monitor/resource-manager/Microsoft.Insights/stable/2016-03-01/examples/patchLogProfile.json
     */
    /**
     * Sample code: Patch a log profile.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void patchALogProfile(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.diagnosticSettings().manager().serviceClient().getLogProfiles().updateWithResponse("Rac46PostSwapRG",
            new LogProfileResourcePatch().withTags(mapOf("key1", "fakeTokenPlaceholder")).withStorageAccountId(
                "/subscriptions/df602c9c-7aa0-407d-a6fb-eb20c8bd1192/resourceGroups/JohnKemTest/providers/Microsoft.Storage/storageAccounts/johnkemtest8162")
                .withServiceBusRuleId("").withLocations(Arrays.asList("global"))
                .withCategories(Arrays.asList("Write", "Delete", "Action")).withRetentionPolicy(
                    new RetentionPolicy().withEnabled(true).withDays(3)),
            com.azure.core.util.Context.NONE);
    }

    // Use "Map.of" if available
    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

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

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/stable/2016-03-01/examples/patchLogProfile.json
func ExampleLogProfilesClient_Update() {
	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.NewLogProfilesClient().Update(ctx, "Rac46PostSwapRG", armmonitor.LogProfileResourcePatch{
		Properties: &armmonitor.LogProfileProperties{
			Categories: []*string{
				to.Ptr("Write"),
				to.Ptr("Delete"),
				to.Ptr("Action")},
			Locations: []*string{
				to.Ptr("global")},
			RetentionPolicy: &armmonitor.RetentionPolicy{
				Days:    to.Ptr[int32](3),
				Enabled: to.Ptr(true),
			},
			ServiceBusRuleID: to.Ptr(""),
			StorageAccountID: to.Ptr("/subscriptions/df602c9c-7aa0-407d-a6fb-eb20c8bd1192/resourceGroups/JohnKemTest/providers/Microsoft.Storage/storageAccounts/johnkemtest8162"),
		},
		Tags: map[string]*string{
			"key1": to.Ptr("value1"),
		},
	}, 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.LogProfileResource = armmonitor.LogProfileResource{
	// 	Name: to.Ptr("default"),
	// 	Type: to.Ptr(""),
	// 	ID: to.Ptr("/subscriptions/df602c9c-7aa0-407d-a6fb-eb20c8bd1192/providers/microsoft.insights/logprofiles/default"),
	// 	Location: to.Ptr(""),
	// 	Tags: map[string]*string{
	// 		"key1": to.Ptr("value1"),
	// 	},
	// 	Properties: &armmonitor.LogProfileProperties{
	// 		Categories: []*string{
	// 			to.Ptr("Delete"),
	// 			to.Ptr("Write"),
	// 			to.Ptr("Action")},
	// 			Locations: []*string{
	// 				to.Ptr("global")},
	// 				RetentionPolicy: &armmonitor.RetentionPolicy{
	// 					Days: to.Ptr[int32](3),
	// 					Enabled: to.Ptr(true),
	// 				},
	// 				ServiceBusRuleID: to.Ptr(""),
	// 				StorageAccountID: to.Ptr("/subscriptions/df602c9c-7aa0-407d-a6fb-eb20c8bd1192/resourceGroups/JohnKemTest/providers/Microsoft.Storage/storageAccounts/johnkemtest8162"),
	// 			},
	// 		}
}

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

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

/**
 * This sample demonstrates how to Updates an existing LogProfilesResource. To update other fields use the CreateOrUpdate method.
 *
 * @summary Updates an existing LogProfilesResource. To update other fields use the CreateOrUpdate method.
 * x-ms-original-file: specification/monitor/resource-manager/Microsoft.Insights/stable/2016-03-01/examples/patchLogProfile.json
 */
async function patchALogProfile() {
  const subscriptionId =
    process.env["MONITOR_SUBSCRIPTION_ID"] || "df602c9c-7aa0-407d-a6fb-eb20c8bd1192";
  const logProfileName = "Rac46PostSwapRG";
  const logProfilesResource = {
    categories: ["Write", "Delete", "Action"],
    locations: ["global"],
    retentionPolicy: { days: 3, enabled: true },
    serviceBusRuleId: "",
    storageAccountId:
      "/subscriptions/df602c9c-7aa0-407d-a6fb-eb20c8bd1192/resourceGroups/JohnKemTest/providers/Microsoft.Storage/storageAccounts/johnkemtest8162",
    tags: { key1: "value1" },
  };
  const credential = new DefaultAzureCredential();
  const client = new MonitorClient(credential, subscriptionId);
  const result = await client.logProfiles.update(logProfileName, logProfilesResource);
  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 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/stable/2016-03-01/examples/patchLogProfile.json
// this example is just showing the usage of "LogProfiles_Update" 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 LogProfileResource created on azure
// for more information of creating LogProfileResource, please refer to the document of LogProfileResource
string subscriptionId = "df602c9c-7aa0-407d-a6fb-eb20c8bd1192";
string logProfileName = "Rac46PostSwapRG";
ResourceIdentifier logProfileResourceId = LogProfileResource.CreateResourceIdentifier(subscriptionId, logProfileName);
LogProfileResource logProfile = client.GetLogProfileResource(logProfileResourceId);

// invoke the operation
LogProfilePatch patch = new LogProfilePatch()
{
    Tags =
    {
    ["key1"] = "value1",
    },
    StorageAccountId = new ResourceIdentifier("/subscriptions/df602c9c-7aa0-407d-a6fb-eb20c8bd1192/resourceGroups/JohnKemTest/providers/Microsoft.Storage/storageAccounts/johnkemtest8162"),
    ServiceBusRuleId = new ResourceIdentifier(""),
    Locations =
    {
    new AzureLocation("global")
    },
    Categories =
    {
    "Write","Delete","Action"
    },
    RetentionPolicy = new RetentionPolicy(true, 3),
};
LogProfileResource result = await logProfile.UpdateAsync(patch);

// 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
LogProfileData 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

Przykładowa odpowiedź

Kod stanu:: 200

{
  "id": "/subscriptions/df602c9c-7aa0-407d-a6fb-eb20c8bd1192/providers/microsoft.insights/logprofiles/default",
  "type": "",
  "name": "default",
  "location": "",
  "tags": {
    "key1": "value1"
  },
  "properties": {
    "storageAccountId": "/subscriptions/df602c9c-7aa0-407d-a6fb-eb20c8bd1192/resourceGroups/JohnKemTest/providers/Microsoft.Storage/storageAccounts/johnkemtest8162",
    "serviceBusRuleId": "",
    "locations": [
      "global"
    ],
    "categories": [
      "Delete",
      "Write",
      "Action"
    ],
    "retentionPolicy": {
      "enabled": true,
      "days": 3
    }
  }
}

Definicje

Nazwa	Opis
ErrorResponse	Opisuje format odpowiedzi na błąd.
LogProfileResource	Zasób profilu dziennika.
LogProfileResourcePatch	Zasób profilu dziennika dla operacji poprawek.
RetentionPolicy	Określa zasady przechowywania dziennika.

ErrorResponse

Opisuje format odpowiedzi na błąd.

Nazwa	Typ	Opis
code	string	Kod błędu
message	string	Komunikat o błędzie wskazujący, dlaczego operacja nie powiodła się.

LogProfileResource

Zasób profilu dziennika.

Nazwa	Typ	Opis
id	string	Identyfikator zasobu platformy Azure
location	string	Lokalizacja zasobu
name	string	Nazwa zasobu platformy Azure
properties.categories	string[]	kategorie dzienników. Te kategorie są tworzone jako wygodne dla użytkownika. Niektóre wartości to: "Write", "Delete" i/or "Action".
properties.locations	string[]	Lista regionów, dla których powinny być przechowywane lub przesyłane strumieniowo zdarzenia dziennika aktywności. Jest to rozdzielona przecinkami lista prawidłowych lokalizacji usługi ARM, w tym lokalizacja "globalna".
properties.retentionPolicy	RetentionPolicy	zasady przechowywania zdarzeń w dzienniku.
properties.serviceBusRuleId	string	Identyfikator reguły magistrali usług dla przestrzeni nazw usługi Service Bus, w której chcesz mieć usługę Event Hubs utworzoną do przesyłania strumieniowego dziennika aktywności. Identyfikator reguły ma format: "{identyfikator zasobu usługi Service Bus}/authorizationrules/{nazwa klucza}".
properties.storageAccountId	string	identyfikator zasobu konta magazynu, do którego chcesz wysłać dziennik aktywności.
tags	object	Tagi zasobów
type	string	Typ zasobu platformy Azure

LogProfileResourcePatch

Zasób profilu dziennika dla operacji poprawek.

Nazwa	Typ	Opis
properties.categories	string[]	kategorie dzienników. Te kategorie są tworzone jako wygodne dla użytkownika. Niektóre wartości to: "Write", "Delete" i/or "Action".
properties.locations	string[]	Lista regionów, dla których powinny być przechowywane lub przesyłane strumieniowo zdarzenia dziennika aktywności. Jest to rozdzielona przecinkami lista prawidłowych lokalizacji usługi ARM, w tym lokalizacja "globalna".
properties.retentionPolicy	RetentionPolicy	zasady przechowywania zdarzeń w dzienniku.
properties.serviceBusRuleId	string	Identyfikator reguły magistrali usług dla przestrzeni nazw usługi Service Bus, w której chcesz mieć usługę Event Hubs utworzoną do przesyłania strumieniowego dziennika aktywności. Identyfikator reguły ma format: "{identyfikator zasobu usługi Service Bus}/authorizationrules/{nazwa klucza}".
properties.storageAccountId	string	identyfikator zasobu konta magazynu, do którego chcesz wysłać dziennik aktywności.
tags	object	Tagi zasobów

RetentionPolicy

Określa zasady przechowywania dziennika.

Nazwa	Typ	Opis
days	integer	liczba dni przechowywania w dniach. Wartość 0 zachowa zdarzenia na czas nieokreślony.
enabled	boolean	wartość wskazująca, czy zasady przechowywania są włączone.

Udostępnij za pośrednictwem

Log Profiles - Update

Parametry identyfikatora URI

Treść żądania

Odpowiedzi

Zabezpieczenia

azure_auth

Zakresy

Przykłady

Patch a log profile

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

ErrorResponse

LogProfileResource

LogProfileResourcePatch

RetentionPolicy

Dodatkowe zasoby