Azure Monitor Workspaces - Update

Odwołanie

Usługa:: Monitor

Wersja interfejsu API:: 2023-04-03

Aktualizacje część obszaru roboczego usługi Azure Monitor

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Monitor/accounts/{azureMonitorWorkspaceName}?api-version=2023-04-03

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
azureMonitorWorkspaceName	path	True	string	Nazwa obszaru roboczego usługi Azure Monitor. Nazwa nie uwzględnia wielkości liter Wzorzec wyrażenia regularnego: `^(?!-)[a-zA-Z0-9-]+[^-]$`
resourceGroupName	path	True	string	Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.
subscriptionId	path	True	string	Identyfikator subskrypcji docelowej.
api-version	query	True	string	Wersja interfejsu API do użycia dla tej operacji.

Treść żądania

Nazwa	Typ	Opis
tags	object	Tagi zasobów

Odpowiedzi

Nazwa	Typ	Opis
200 OK	AzureMonitorWorkspaceResource	Obszar roboczy usługi Azure Monitor został pomyślnie zaktualizowany
Other Status Codes	ErrorResponse	Błąd

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

Update an Azure Monitor Workspace

Przykładowe żądanie

PATCH https://management.azure.com/subscriptions/703362b3-f278-4e4b-9179-c76eaf41ffc2/resourceGroups/myResourceGroup/providers/Microsoft.Monitor/accounts/myAzureMonitorWorkspace?api-version=2023-04-03

{
  "tags": {
    "tag1": "A",
    "tag2": "B",
    "tag3": "C"
  }
}

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

/**
 * This sample demonstrates how to Updates part of an Azure Monitor Workspace
 *
 * @summary Updates part of an Azure Monitor Workspace
 * x-ms-original-file: specification/monitor/resource-manager/Microsoft.Monitor/stable/2023-04-03/examples/AzureMonitorWorkspacesUpdate.json
 */
async function updateAnAzureMonitorWorkspace() {
  const subscriptionId =
    process.env["MONITOR_SUBSCRIPTION_ID"] || "703362b3-f278-4e4b-9179-c76eaf41ffc2";
  const resourceGroupName = process.env["MONITOR_RESOURCE_GROUP"] || "myResourceGroup";
  const azureMonitorWorkspaceName = "myAzureMonitorWorkspace";
  const azureMonitorWorkspaceProperties = { tags: { tag1: "A", tag2: "B", tag3: "C" } };
  const options = {
    azureMonitorWorkspaceProperties,
  };
  const credential = new DefaultAzureCredential();
  const client = new MonitorClient(credential, subscriptionId);
  const result = await client.azureMonitorWorkspaces.update(
    resourceGroupName,
    azureMonitorWorkspaceName,
    options,
  );
  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.Monitor;
using Azure.ResourceManager.Monitor.Models;
using Azure.ResourceManager.Resources;

// Generated from example definition: specification/monitor/resource-manager/Microsoft.Monitor/stable/2023-04-03/examples/AzureMonitorWorkspacesUpdate.json
// this example is just showing the usage of "AzureMonitorWorkspaces_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 MonitorWorkspaceResource created on azure
// for more information of creating MonitorWorkspaceResource, please refer to the document of MonitorWorkspaceResource
string subscriptionId = "703362b3-f278-4e4b-9179-c76eaf41ffc2";
string resourceGroupName = "myResourceGroup";
string azureMonitorWorkspaceName = "myAzureMonitorWorkspace";
ResourceIdentifier monitorWorkspaceResourceId = MonitorWorkspaceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, azureMonitorWorkspaceName);
MonitorWorkspaceResource monitorWorkspaceResource = client.GetMonitorWorkspaceResource(monitorWorkspaceResourceId);

// invoke the operation
MonitorWorkspaceResourcePatch patch = new MonitorWorkspaceResourcePatch()
{
    Tags =
    {
    ["tag1"] = "A",
    ["tag2"] = "B",
    ["tag3"] = "C",
    },
};
MonitorWorkspaceResource result = await monitorWorkspaceResource.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
MonitorWorkspaceResourceData 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/703362b3-f278-4e4b-9179-c76eaf41ffc2/resourceGroups/myResourceGroup/providers/Microsoft.Monitor/accounts/myAzureMonitorWorkspace",
  "name": "myAzureMonitorWorkspace",
  "type": "Microsoft.Monitor/accounts",
  "location": "eastus",
  "tags": {
    "tag1": "A",
    "tag2": "B",
    "tag3": "C"
  },
  "properties": {
    "accountId": "2df515bf-c3ce-4920-84d4-1d9d16542d9f",
    "metrics": {
      "prometheusQueryEndpoint": "https://myAzureMonitorWorkspace-v8hx.eastus.prometheus.monitor.azure.com",
      "internalId": "mac_2df515bf-c3ce-4920-84d4-1d9d16542d9f"
    },
    "provisioningState": "Succeeded",
    "defaultIngestionSettings": {
      "dataCollectionRuleResourceId": "/subscriptions/703362b3-f278-4e4b-9179-c76eaf41ffc2/resourceGroups/MA_myAzureMonitorWorkspace_eastus_managed/providers/Microsoft.Insights/dataCollectionRules/myAzureMonitorWorkspace",
      "dataCollectionEndpointResourceId": "/subscriptions/703362b3-f278-4e4b-9179-c76eaf41ffc2/resourceGroups/MA_myAzureMonitorWorkspace_eastus_managed/providers/Microsoft.Insights/dataCollectionEndpoints/myAzureMonitorWorkspace"
    },
    "privateEndpointConnections": [
      {
        "id": "/subscriptions/703362b3-f278-4e4b-9179-c76eaf41ffc2/resourceGroups/myResourceGroup/providers/Microsoft.Monitor/accounts/myAzureMonitorWorkspace/privateEndpointConnections/myPrivateEndpointConnection",
        "name": "myPrivateEndpointConnection",
        "type": "Microsoft.Monitor/accounts/privateEndpointConnections",
        "properties": {
          "provisioningState": "Succeeded",
          "privateEndpoint": {
            "id": "/subscriptions/703362b3-f278-4e4b-9179-c76eaf41ffc2/resourceGroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpointConnection"
          },
          "groupIds": [
            "prometheusMetrics"
          ],
          "privateLinkServiceConnectionState": {
            "status": "Approved",
            "description": "Auto-approved",
            "actionsRequired": "None"
          }
        }
      }
    ],
    "publicNetworkAccess": "Enabled"
  },
  "systemData": {
    "createdBy": "user1",
    "createdByType": "User",
    "createdAt": "2021-04-01T12:34:56.1234567Z",
    "lastModifiedBy": "user2",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2021-04-02T12:34:56.1234567Z"
  },
  "etag": "070057da-0000-0000-0000-5ba70d6c0000"
}

Definicje

Nazwa	Opis
AzureMonitorWorkspaceResource	Definicja obszaru roboczego usługi Azure Monitor
AzureMonitorWorkspaceResourceForUpdate	Definicja właściwości zasobu najwyższego poziomu śledzonych przez usługę ARM dla operacji aktualizacji
createdByType	Typ tożsamości, która utworzyła zasób.
DefaultIngestionSettings	Reguła zbierania danych i punkt końcowy używany do pozyskiwania danych domyślnie.
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
Metrics	Właściwości związane z kontenerem metryk w obszarze roboczym usługi Azure Monitor
PrivateEndpoint	Zasób prywatnego punktu końcowego.
PrivateEndpointConnection	Zasób połączenia prywatnego punktu końcowego.
PrivateEndpointConnectionProvisioningState	Bieżący stan aprowizacji.
PrivateEndpointServiceConnectionStatus	Stan połączenia prywatnego punktu końcowego.
PrivateLinkServiceConnectionState	Kolekcja informacji o stanie połączenia między konsumentem usługi a dostawcą.
ProvisioningState	Stan aprowizacji obszaru roboczego usługi Azure Monitor. Ustaw wartość Powodzenie, jeśli wszystko jest w dobrej kondycji.
PublicNetworkAccess	Pobiera lub ustawia zezwala lub nie zezwala na dostęp sieci publicznej do obszaru roboczego usługi Azure Monitor
systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

AzureMonitorWorkspaceResource

Definicja obszaru roboczego usługi Azure Monitor

Nazwa	Typ	Opis
etag	string	Tag jednostki zasobu (ETag)
id	string	W pełni kwalifikowany identyfikator zasobu dla zasobu. Np. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location	string	Lokalizacja geograficzna, w której znajduje się zasób
name	string	Nazwa zasobu
properties.accountId	string	Niezmienny identyfikator obszaru roboczego usługi Azure Monitor. Ta właściwość jest tylko do odczytu.
properties.defaultIngestionSettings	DefaultIngestionSettings	Reguła zbierania danych i punkt końcowy używany do pozyskiwania danych domyślnie.
properties.metrics	Metrics	Właściwości związane z kontenerem metryk w obszarze roboczym usługi Azure Monitor
properties.privateEndpointConnections	PrivateEndpointConnection[]	Lista połączeń prywatnych punktów końcowych
properties.provisioningState	ProvisioningState	Stan aprowizacji obszaru roboczego usługi Azure Monitor. Ustaw wartość Powodzenie, jeśli wszystko jest w dobrej kondycji.
properties.publicNetworkAccess	PublicNetworkAccess	Pobiera lub ustawia zezwala lub nie zezwala na dostęp sieci publicznej do obszaru roboczego usługi Azure Monitor
systemData	systemData	Metadane usługi Azure Resource Manager zawierające informacje createdBy i modifiedBy.
tags	object	Tagi zasobów.
type	string	Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

AzureMonitorWorkspaceResourceForUpdate

Definicja właściwości zasobu najwyższego poziomu śledzonych przez usługę ARM dla operacji aktualizacji

Nazwa	Typ	Opis
tags	object	Tagi zasobów

createdByType

Typ tożsamości, która utworzyła zasób.

Nazwa	Typ	Opis
Application	string
Key	string
ManagedIdentity	string
User	string

DefaultIngestionSettings

Reguła zbierania danych i punkt końcowy używany do pozyskiwania danych domyślnie.

Nazwa	Typ	Opis
dataCollectionEndpointResourceId	string	Identyfikator zasobu platformy Azure domyślnego punktu końcowego zbierania danych dla tego obszaru roboczego usługi Azure Monitor.
dataCollectionRuleResourceId	string	Identyfikator zasobu platformy Azure domyślnej reguły zbierania danych dla tego obszaru roboczego usługi Azure Monitor.

ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorDetail

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorDetail[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorResponse

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt error.

Metrics

Właściwości związane z kontenerem metryk w obszarze roboczym usługi Azure Monitor

Nazwa	Typ	Opis
internalId	string	Wewnętrzny identyfikator kontenera metryk. Tylko do użycia przez system
prometheusQueryEndpoint	string	Punkt końcowy zapytania rozwiązania Prometheus dla obszaru roboczego usługi Azure Monitor

PrivateEndpoint

Zasób prywatnego punktu końcowego.

Nazwa	Typ	Opis
id	string	Identyfikator usługi ARM dla prywatnego punktu końcowego.

PrivateEndpointConnection

Zasób połączenia prywatnego punktu końcowego.

Nazwa	Typ	Opis
id	string	W pełni kwalifikowany identyfikator zasobu dla zasobu. Np. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Nazwa zasobu
properties.groupIds	string[]	Identyfikatory grupy dla zasobu prywatnego punktu końcowego.
properties.privateEndpoint	PrivateEndpoint	Zasób prywatnego punktu końcowego.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Kolekcja informacji o stanie połączenia między konsumentem usługi a dostawcą.
properties.provisioningState	PrivateEndpointConnectionProvisioningState	Stan aprowizacji zasobu połączenia prywatnego punktu końcowego.
systemData	systemData	Metadane usługi Azure Resource Manager zawierające informacje createdBy i modifiedBy.
type	string	Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionProvisioningState

Bieżący stan aprowizacji.

Nazwa	Typ	Opis
Creating	string
Deleting	string
Failed	string
Succeeded	string

PrivateEndpointServiceConnectionStatus

Stan połączenia prywatnego punktu końcowego.

Nazwa	Typ	Opis
Approved	string
Pending	string
Rejected	string

PrivateLinkServiceConnectionState

Kolekcja informacji o stanie połączenia między konsumentem usługi a dostawcą.

Nazwa	Typ	Opis
actionsRequired	string	Komunikat wskazujący, czy zmiany dostawcy usług wymagają aktualizacji u konsumenta.
description	string	Przyczyna zatwierdzenia/odrzucenia połączenia.
status	PrivateEndpointServiceConnectionStatus	Wskazuje, czy połączenie zostało zatwierdzone/odrzucone/usunięte przez właściciela usługi.

ProvisioningState

Stan aprowizacji obszaru roboczego usługi Azure Monitor. Ustaw wartość Powodzenie, jeśli wszystko jest w dobrej kondycji.

Nazwa	Typ	Opis
Canceled	string
Creating	string
Deleting	string
Failed	string
Succeeded	string

PublicNetworkAccess

Pobiera lub ustawia zezwala lub nie zezwala na dostęp sieci publicznej do obszaru roboczego usługi Azure Monitor

Nazwa	Typ	Opis
Disabled	string
Enabled	string

systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa	Typ	Opis
createdAt	string	Sygnatura czasowa tworzenia zasobów (UTC).
createdBy	string	Tożsamość, która utworzyła zasób.
createdByType	createdByType	Typ tożsamości, która utworzyła zasób.
lastModifiedAt	string	Sygnatura czasowa ostatniej modyfikacji zasobu (UTC)
lastModifiedBy	string	Tożsamość, która ostatnio zmodyfikowała zasób.
lastModifiedByType	createdByType	Typ tożsamości, która ostatnio zmodyfikowała zasób.

Udostępnij za pośrednictwem