Azure Monitor Workspaces - Update

Referenz

Dienst:: Monitor

API-Version:: 2023-04-03

Updates Teil eines Azure Monitor-Arbeitsbereichs

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
azureMonitorWorkspaceName	path	True	string	Der Name des Azure Monitor-Arbeitsbereichs. Beim Namen wird die Groß-/Kleinschreibung nicht beachtet. RegEx-Muster: `^(?!-)[a-zA-Z0-9-]+[^-]$`
resourceGroupName	path	True	string	Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.
subscriptionId	path	True	string	Hierbei handelt es sich um die ID des Zielabonnements.
api-version	query	True	string	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Anforderungstext

Name	Typ	Beschreibung
tags	object	Ressourcentags

Antworten

Name	Typ	Beschreibung
200 OK	AzureMonitorWorkspaceResource	Azure Monitor-Arbeitsbereich wurde erfolgreich aktualisiert
Other Status Codes	ErrorResponse	Fehler

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

Update an Azure Monitor Workspace

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:: 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"
}

Definitionen

Name	Beschreibung
AzureMonitorWorkspaceResource	Eine Azure Monitor-Arbeitsbereichsdefinition
AzureMonitorWorkspaceResourceForUpdate	Definition von ARM-nachverfolgten Ressourceneigenschaften der obersten Ebene für den Updatevorgang
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
DefaultIngestionSettings	Die Datensammlungsregel und der Endpunkt, die standardmäßig für die Erfassung verwendet werden.
ErrorAdditionalInfo	Zusätzliche Informationen zum Ressourcenverwaltungsfehler.
ErrorDetail	Die Fehlerdetails.
ErrorResponse	Fehlerantwort
Metrics	Eigenschaften im Zusammenhang mit dem Metrikcontainer im Azure Monitor-Arbeitsbereich
PrivateEndpoint	Die private Endpunktressource.
PrivateEndpointConnection	Die Verbindungsressource des privaten Endpunkts.
PrivateEndpointConnectionProvisioningState	Der aktuelle Bereitstellungsstatus.
PrivateEndpointServiceConnectionStatus	Die private Endpunktverbindung status.
PrivateLinkServiceConnectionState	Eine Sammlung von Informationen über den Status der Verbindung zwischen dem Dienst consumer und dem Anbieter.
ProvisioningState	Der Bereitstellungsstatus des Azure Monitor-Arbeitsbereichs. Legen Sie auf Erfolgreich fest, wenn alles fehlerfrei ist.
PublicNetworkAccess	Ruft ab, oder legt das Zulassen oder Verweigern des Öffentlichen Netzwerkzugriffs auf Azure Monitor-Arbeitsbereich fest.
systemData	Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

AzureMonitorWorkspaceResource

Eine Azure Monitor-Arbeitsbereichsdefinition

Name	Typ	Beschreibung
etag	string	Ressourcenentitätstag (ETag)
id	string	Vollqualifizierte Ressourcen-ID für die Ressource. Beispiel: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location	string	Der geografische Standort, an dem sich die Ressource befindet
name	string	Der Name der Ressource
properties.accountId	string	Die unveränderliche ID des Azure Monitor-Arbeitsbereichs. Diese Eigenschaft ist schreibgeschützt.
properties.defaultIngestionSettings	DefaultIngestionSettings	Die Datensammlungsregel und der Endpunkt, die standardmäßig für die Erfassung verwendet werden.
properties.metrics	Metrics	Eigenschaften im Zusammenhang mit dem Metrikcontainer im Azure Monitor-Arbeitsbereich
properties.privateEndpointConnections	PrivateEndpointConnection[]	Liste der Verbindungen mit privaten Endpunkten
properties.provisioningState	ProvisioningState	Der Bereitstellungsstatus des Azure Monitor-Arbeitsbereichs. Legen Sie auf Erfolgreich fest, wenn alles fehlerfrei ist.
properties.publicNetworkAccess	PublicNetworkAccess	Ruft ab, oder legt das Zulassen oder Verweigern des Öffentlichen Netzwerkzugriffs auf Azure Monitor-Arbeitsbereich fest.
systemData	systemData	Azure Resource Manager-Metadaten mit createdBy- und modifiedBy-Informationen.
tags	object	Ressourcentags.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

AzureMonitorWorkspaceResourceForUpdate

Definition von ARM-nachverfolgten Ressourceneigenschaften der obersten Ebene für den Updatevorgang

Name	Typ	Beschreibung
tags	object	Ressourcentags

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

Name	Typ	Beschreibung
Application	string
Key	string
ManagedIdentity	string
User	string

DefaultIngestionSettings

Die Datensammlungsregel und der Endpunkt, die standardmäßig für die Erfassung verwendet werden.

Name	Typ	Beschreibung
dataCollectionEndpointResourceId	string	Die Azure-Ressourcen-ID des Standardendpunkts für die Datensammlung für diesen Azure Monitor-Arbeitsbereich.
dataCollectionRuleResourceId	string	Die Azure-Ressourcen-ID der Standarddatensammlungsregel für diesen Azure Monitor-Arbeitsbereich.

ErrorAdditionalInfo

Zusätzliche Informationen zum Ressourcenverwaltungsfehler.

Name	Typ	Beschreibung
info	object	Zusätzliche Informationen.
type	string	Typ der zusätzlichen Informationen.

ErrorDetail

Die Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Fehlerinformationen.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

Metrics

Eigenschaften im Zusammenhang mit dem Metrikcontainer im Azure Monitor-Arbeitsbereich

Name	Typ	Beschreibung
internalId	string	Ein interner Bezeichner für den Metrikcontainer. Nur vom System zu verwenden
prometheusQueryEndpoint	string	Der Prometheus-Abfrageendpunkt für den Azure Monitor-Arbeitsbereich

PrivateEndpoint

Die private Endpunktressource.

Name	Typ	Beschreibung
id	string	Der ARM-Bezeichner für den privaten Endpunkt.

PrivateEndpointConnection

Die Verbindungsressource des privaten Endpunkts.

Name	Typ	Beschreibung
id	string	Vollqualifizierte Ressourcen-ID für die Ressource. Beispiel: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Der Name der Ressource
properties.groupIds	string[]	Die Gruppen-IDs für die private Endpunktressource.
properties.privateEndpoint	PrivateEndpoint	Die private Endpunktressource.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Eine Sammlung von Informationen über den Status der Verbindung zwischen dem Dienst consumer und dem Anbieter.
properties.provisioningState	PrivateEndpointConnectionProvisioningState	Der Bereitstellungsstatus der Verbindungsressource des privaten Endpunkts.
systemData	systemData	Azure Resource Manager-Metadaten mit createdBy- und modifiedBy-Informationen.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionProvisioningState

Der aktuelle Bereitstellungsstatus.

Name	Typ	Beschreibung
Creating	string
Deleting	string
Failed	string
Succeeded	string

PrivateEndpointServiceConnectionStatus

Die private Endpunktverbindung status.

Name	Typ	Beschreibung
Approved	string
Pending	string
Rejected	string

PrivateLinkServiceConnectionState

Eine Sammlung von Informationen über den Status der Verbindung zwischen dem Dienst consumer und dem Anbieter.

Name	Typ	Beschreibung
actionsRequired	string	Eine Meldung, die angibt, ob Änderungen am Dienstanbieter Updates für den Consumer erfordern.
description	string	Der Grund für die Genehmigung/Ablehnung der Verbindung.
status	PrivateEndpointServiceConnectionStatus	Gibt an, ob die Verbindung vom Besitzer des Diensts genehmigt/abgelehnt/entfernt wurde.

ProvisioningState

Der Bereitstellungsstatus des Azure Monitor-Arbeitsbereichs. Legen Sie auf Erfolgreich fest, wenn alles fehlerfrei ist.

Name	Typ	Beschreibung
Canceled	string
Creating	string
Deleting	string
Failed	string
Succeeded	string

PublicNetworkAccess

Ruft ab, oder legt das Zulassen oder Verweigern des Öffentlichen Netzwerkzugriffs auf Azure Monitor-Arbeitsbereich fest.

Name	Typ	Beschreibung
Disabled	string
Enabled	string

systemData

Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

Name	Typ	Beschreibung
createdAt	string	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.

Freigeben über