Azure Monitor Workspaces - List By Resource Group

Referentie

Service:: Monitor

API Version:: 2023-04-03

Lijsten alle Azure Monitor-werkruimten in de opgegeven resourcegroep

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

URI-parameters

Name	In	Vereist	Type	Description
resourceGroupName	path	True	string	De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
subscriptionId	path	True	string	De id van het doelabonnement.
api-version	query	True	string	De API-versie die voor deze bewerking moet worden gebruikt.

Antwoorden

Name	Type	Description
200 OK	AzureMonitorWorkspaceResourceListResult	Aanvraag is voltooid
Other Status Codes	ErrorResponse	Fout

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

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

Scopes

Name	Description
user_impersonation	uw gebruikersaccount imiteren

Voorbeelden

List Azure Monitor Workspaces by resource group

Sample Request

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

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

/**
 * This sample demonstrates how to Lists all Azure Monitor Workspaces in the specified resource group
 *
 * @summary Lists all Azure Monitor Workspaces in the specified resource group
 * x-ms-original-file: specification/monitor/resource-manager/Microsoft.Monitor/stable/2023-04-03/examples/AzureMonitorWorkspacesListByResourceGroup.json
 */
async function listAzureMonitorWorkspacesByResourceGroup() {
  const subscriptionId =
    process.env["MONITOR_SUBSCRIPTION_ID"] || "703362b3-f278-4e4b-9179-c76eaf41ffc2";
  const resourceGroupName = process.env["MONITOR_RESOURCE_GROUP"] || "myResourceGroup";
  const credential = new DefaultAzureCredential();
  const client = new MonitorClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.azureMonitorWorkspaces.listByResourceGroup(resourceGroupName)) {
    resArray.push(item);
  }
  console.log(resArray);
}

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.Resources;

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

// get the collection of this MonitorWorkspaceResource
MonitorWorkspaceResourceCollection collection = resourceGroupResource.GetMonitorWorkspaceResources();

// invoke the operation and iterate over the result
await foreach (MonitorWorkspaceResource item in collection.GetAllAsync())
{
    // the variable item 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 = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine($"Succeeded");

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

{
  "value": [
    {
      "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"
      },
      "properties": {
        "accountId": "2df515bf-c3ce-4920-84d4-1d9d16542d9f",
        "metrics": {
          "prometheusQueryEndpoint": "https://myAzureMonitorWorkspace-abcd.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"
    },
    {
      "id": "/subscriptions/703362b3-f278-4e4b-9179-c76eaf41ffc2/resourceGroups/myResourceGroup/providers/Microsoft.Monitor/accounts/herAzureMonitorWorkspace",
      "name": "herAzureMonitorWorkspace",
      "type": "Microsoft.Monitor/accounts",
      "location": "westus",
      "tags": {
        "tag1": "A",
        "tag2": "B"
      },
      "properties": {
        "accountId": "823220c6-0415-44d8-bfb2-d5c1c9ea1172",
        "metrics": {
          "prometheusQueryEndpoint": "https://herAzureMonitorWorkspace-xywz.eastus.prometheus.monitor.azure.com",
          "internalId": "mac_823220c6-0415-44d8-bfb2-d5c1c9ea1172"
        },
        "provisioningState": "Succeeded",
        "defaultIngestionSettings": {
          "dataCollectionRuleResourceId": "/subscriptions/703362b3-f278-4e4b-9179-c76eaf41ffc2/resourceGroups/MA_herAzureMonitorWorkspace_eastus_managed/providers/Microsoft.Insights/dataCollectionRules/herAzureMonitorWorkspace",
          "dataCollectionEndpointResourceId": "/subscriptions/703362b3-f278-4e4b-9179-c76eaf41ffc2/resourceGroups/MA_herAzureMonitorWorkspace_eastus_managed/providers/Microsoft.Insights/dataCollectionEndpoints/herAzureMonitorWorkspace"
        },
        "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"
    }
  ],
  "nextLink": null
}

Definities

Name	Description
AzureMonitorWorkspaceResource	Definitie van een Azure Monitor-werkruimte
AzureMonitorWorkspaceResourceListResult	Een wisselbare lijst met resources
createdByType	Het type identiteit waarmee de resource is gemaakt.
DefaultIngestionSettings	De gegevensverzamelingsregel en het eindpunt die standaard worden gebruikt voor opname.
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie
Metrics	Eigenschappen met betrekking tot de container met metrische gegevens in de Azure Monitor-werkruimte
PrivateEndpoint	De resource van het privé-eindpunt.
PrivateEndpointConnection	De privé-eindpuntverbindingsresource.
PrivateEndpointConnectionProvisioningState	De huidige inrichtingsstatus.
PrivateEndpointServiceConnectionStatus	De verbindingsstatus van het privé-eindpunt.
PrivateLinkServiceConnectionState	Een verzameling informatie over de status van de verbinding tussen de servicegebruiker en de provider.
ProvisioningState	De inrichtingsstatus van de Azure Monitor-werkruimte. Stel in op Geslaagd als alles in orde is.
PublicNetworkAccess	Hiermee wordt openbare netwerktoegang tot Azure Monitor-werkruimte toegestaan of ingesteld
systemData	Metagegevens met betrekking tot het maken en laatste wijzigen van de resource.

AzureMonitorWorkspaceResource

Definitie van een Azure Monitor-werkruimte

Name	Type	Description
etag	string	Resource-entiteitstag (ETag)
id	string	Volledig gekwalificeerde resource-id voor de resource. Bijvoorbeeld "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location	string	De geografische locatie waar de resource zich bevindt
name	string	De naam van de resource
properties.accountId	string	De onveranderbare id van de Azure Monitor-werkruimte. Deze eigenschap heeft het kenmerk Alleen-lezen.
properties.defaultIngestionSettings	DefaultIngestionSettings	De gegevensverzamelingsregel en het eindpunt die standaard worden gebruikt voor opname.
properties.metrics	Metrics	Eigenschappen met betrekking tot de container met metrische gegevens in de Azure Monitor-werkruimte
properties.privateEndpointConnections	PrivateEndpointConnection[]	Lijst met privé-eindpuntverbindingen
properties.provisioningState	ProvisioningState	De inrichtingsstatus van de Azure Monitor-werkruimte. Stel in op Geslaagd als alles in orde is.
properties.publicNetworkAccess	PublicNetworkAccess	Hiermee wordt openbare netwerktoegang tot Azure Monitor-werkruimte toegestaan of ingesteld
systemData	systemData	Azure Resource Manager metagegevens met informatie over createdBy en modifiedBy.
tags	object	Resourcetags.
type	string	Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

AzureMonitorWorkspaceResourceListResult

Een wisselbare lijst met resources

Name	Type	Description
nextLink	string	De URL die moet worden gebruikt voor het ophalen van de volgende set resultaten
value	AzureMonitorWorkspaceResource[]	Een lijst met resources

createdByType

Het type identiteit waarmee de resource is gemaakt.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

DefaultIngestionSettings

De gegevensverzamelingsregel en het eindpunt die standaard worden gebruikt voor opname.

Name	Type	Description
dataCollectionEndpointResourceId	string	De Azure-resource-id van het standaardeindpunt voor gegevensverzameling voor deze Azure Monitor-werkruimte.
dataCollectionRuleResourceId	string	De Azure-resource-id van de standaardregel voor gegevensverzameling voor deze Azure Monitor-werkruimte.

ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het type aanvullende informatie.

ErrorDetail

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Aanvullende informatie over de fout.
code	string	De foutcode.
details	ErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorResponse

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.

Metrics

Eigenschappen met betrekking tot de container met metrische gegevens in de Azure Monitor-werkruimte

Name	Type	Description
internalId	string	Een interne id voor de container met metrische gegevens. Alleen te gebruiken door het systeem
prometheusQueryEndpoint	string	Het Prometheus-queryeindpunt voor de Azure Monitor-werkruimte

PrivateEndpoint

De resource van het privé-eindpunt.

Name	Type	Description
id	string	De ARM-id voor het privé-eindpunt.

PrivateEndpointConnection

De privé-eindpuntverbindingsresource.

Name	Type	Description
id	string	Volledig gekwalificeerde resource-id voor de resource. Bijvoorbeeld "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	De naam van de resource
properties.groupIds	string[]	De groeps-id's voor de privé-eindpuntresource.
properties.privateEndpoint	PrivateEndpoint	De resource van het privé-eindpunt.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Een verzameling informatie over de status van de verbinding tussen de servicegebruiker en de provider.
properties.provisioningState	PrivateEndpointConnectionProvisioningState	De inrichtingsstatus van de privé-eindpuntverbindingsresource.
systemData	systemData	Azure Resource Manager metagegevens met informatie over createdBy en modifiedBy.
type	string	Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

PrivateEndpointConnectionProvisioningState

De huidige inrichtingsstatus.

Name	Type	Description
Creating	string
Deleting	string
Failed	string
Succeeded	string

PrivateEndpointServiceConnectionStatus

De verbindingsstatus van het privé-eindpunt.

Name	Type	Description
Approved	string
Pending	string
Rejected	string

PrivateLinkServiceConnectionState

Een verzameling informatie over de status van de verbinding tussen de servicegebruiker en de provider.

Name	Type	Description
actionsRequired	string	Een bericht waarin wordt aangegeven of wijzigingen in de serviceprovider updates voor de consument vereisen.
description	string	De reden voor goedkeuring/afwijzing van de verbinding.
status	PrivateEndpointServiceConnectionStatus	Geeft aan of de verbinding is goedgekeurd/geweigerd/verwijderd door de eigenaar van de service.

ProvisioningState

De inrichtingsstatus van de Azure Monitor-werkruimte. Stel in op Geslaagd als alles in orde is.

Name	Type	Description
Canceled	string
Creating	string
Deleting	string
Failed	string
Succeeded	string

PublicNetworkAccess

Hiermee wordt openbare netwerktoegang tot Azure Monitor-werkruimte toegestaan of ingesteld

Name	Type	Description
Disabled	string
Enabled	string

systemData

Metagegevens met betrekking tot het maken en laatste wijzigen van de resource.

Name	Type	Description
createdAt	string	Het tijdstempel van het maken van resources (UTC).
createdBy	string	De identiteit waarmee de resource is gemaakt.
createdByType	createdByType	Het type identiteit waarmee de resource is gemaakt.
lastModifiedAt	string	De tijdstempel van de laatste wijziging van de resource (UTC)
lastModifiedBy	string	De identiteit die de resource het laatst heeft gewijzigd.
lastModifiedByType	createdByType	Het type identiteit dat de resource het laatst heeft gewijzigd.

Delen via