Azure Monitor Workspaces - List By Resource Group

Szolgáltatás:: Monitor

API-verzió:: 2023-04-03

A megadott erőforráscsoport összes Azure Monitor-munkaterületének listája

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.
subscriptionId	path	True	string minLength: 1	A cél-előfizetés azonosítója.
api-version	query	True	string minLength: 1	A művelethez használni kívánt API-verzió.

Válaszok

Name	Típus	Description
200 OK	AzureMonitorWorkspaceResourceListResult	A kérelem sikeresen befejeződött
Other Status Codes	ErrorResponse	Hiba

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
user_impersonation	a felhasználói fiók megszemélyesítése

Példák

List Azure Monitor Workspaces by resource group

Mintakérelem

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

from azure.identity import DefaultAzureCredential

from azure.mgmt.monitor import MonitorManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-monitor
# USAGE
    python azure_monitor_workspaces_list_by_resource_group.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="703362b3-f278-4e4b-9179-c76eaf41ffc2",
    )

    response = client.azure_monitor_workspaces.list_by_resource_group(
        resource_group_name="myResourceGroup",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/monitor/resource-manager/Microsoft.Monitor/stable/2023-04-03/examples/AzureMonitorWorkspacesListByResourceGroup.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

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 Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Monitor;

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

Mintaválasz

Állapotkód:: 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
}

Definíciók

Name	Description
AzureMonitorWorkspaceResource	Azure Monitor-munkaterület definíciója
AzureMonitorWorkspaceResourceListResult	Az erőforrások lapozható listája
createdByType	Az erőforrást létrehozó identitás típusa.
DefaultIngestionSettings	Alapértelmezés szerint a betöltéshez használt adatgyűjtési szabály és végpont.
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorDetail	A hiba részletei.
ErrorResponse	Hibaválasz
Metrics	Az Azure Monitor-munkaterület metrikakonténeréhez kapcsolódó tulajdonságok
PrivateEndpoint	A privát végpont erőforrása.
PrivateEndpointConnection	A privát végpont kapcsolati erőforrása.
PrivateEndpointConnectionProvisioningState	Az aktuális kiépítési állapot.
PrivateEndpointServiceConnectionStatus	A privát végpont kapcsolatának állapota.
PrivateLinkServiceConnectionState	A szolgáltatásfelhasználó és a szolgáltató közötti kapcsolat állapotával kapcsolatos információk gyűjteménye.
ProvisioningState	Az Azure Monitor-munkaterület kiépítési állapota. Ha minden rendben van, állítsa a Sikeres értékre.
PublicNetworkAccess	Lekérdezi vagy beállítja az Azure Monitor-munkaterület nyilvános hálózati hozzáférésének engedélyezését vagy letiltását
systemData	Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

AzureMonitorWorkspaceResource

Objektum

Azure Monitor-munkaterület definíciója

Name	Típus	Description
etag	string	Erőforrás-entitás címkéje (ETag)
id	string (arm-id)	Az erőforrás teljes erőforrás-azonosítója. Például: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location	string	Az a földrajzi hely, ahol az erőforrás él
name	string	Az erőforrás neve
properties.accountId	string	Az Azure Monitor-munkaterület nem módosítható azonosítója. Ez a tulajdonság írásvédett.
properties.defaultIngestionSettings	DefaultIngestionSettings	Alapértelmezés szerint a betöltéshez használt adatgyűjtési szabály és végpont.
properties.metrics	Metrics	Az Azure Monitor-munkaterület metrikakonténeréhez kapcsolódó tulajdonságok
properties.privateEndpointConnections	PrivateEndpointConnection[]	Privát végpontkapcsolatok listája
properties.provisioningState	ProvisioningState	Az Azure Monitor-munkaterület kiépítési állapota. Ha minden rendben van, állítsa a Sikeres értékre.
properties.publicNetworkAccess	PublicNetworkAccess	Lekérdezi vagy beállítja az Azure Monitor-munkaterület nyilvános hálózati hozzáférésének engedélyezését vagy letiltását
systemData	systemData	A createdBy és a modifiedBy adatokat tartalmazó Azure Resource Manager-metaadatok.
tags	object	Erőforráscímkék.
type	string	Az erőforrás típusa. Pl. "Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts"

AzureMonitorWorkspaceResourceListResult

Objektum

Az erőforrások lapozható listája

Name	Típus	Description
nextLink	string	A következő találatkészlet lekéréséhez használandó URL-cím
value	AzureMonitorWorkspaceResource[]	Erőforrások listája

createdByType

Enumerálás

Az erőforrást létrehozó identitás típusa.

Érték	Description
Application
Key
ManagedIdentity
User

DefaultIngestionSettings

Objektum

Alapértelmezés szerint a betöltéshez használt adatgyűjtési szabály és végpont.

Name	Típus	Description
dataCollectionEndpointResourceId	string	Az Azure Monitor-munkaterület alapértelmezett adatgyűjtési végpontjának Azure-erőforrás-azonosítója.
dataCollectionRuleResourceId	string	Az Azure Monitor-munkaterület alapértelmezett adatgyűjtési szabályának Azure-erőforrás-azonosítója.

ErrorAdditionalInfo

Objektum

Az erőforrás-kezelési hiba további információi.

Name	Típus	Description
info	object	A további információk.
type	string	A további információtípus.

ErrorDetail

Objektum

A hiba részletei.

Name	Típus	Description
additionalInfo	ErrorAdditionalInfo[]	A hiba további információi.
code	string	A hibakód.
details	ErrorDetail[]	A hiba részletei.
message	string	A hibaüzenet.
target	string	A hibacél.

ErrorResponse

Objektum

Hibaválasz

Name	Típus	Description
error	ErrorDetail	A hibaobjektum.

Metrics

Objektum

Az Azure Monitor-munkaterület metrikakonténeréhez kapcsolódó tulajdonságok

Name	Típus	Description
internalId	string	A metrikák tárolójának belső azonosítója. Csak a rendszer használhatja
prometheusQueryEndpoint	string	Az Azure Monitor-munkaterület Prometheus lekérdezési végpontja

PrivateEndpoint

Objektum

A privát végpont erőforrása.

Name	Típus	Description
id	string	A privát végpont ARM-azonosítója.

PrivateEndpointConnection

Objektum

A privát végpont kapcsolati erőforrása.

Name	Típus	Description
id	string (arm-id)	Az erőforrás teljes erőforrás-azonosítója. Például: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Az erőforrás neve
properties.groupIds	string[]	A privát végpont erőforrásának csoportazonosítói.
properties.privateEndpoint	PrivateEndpoint	A privát végpont erőforrása.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	A szolgáltatásfelhasználó és a szolgáltató közötti kapcsolat állapotával kapcsolatos információk gyűjteménye.
properties.provisioningState	PrivateEndpointConnectionProvisioningState	A privát végpont kapcsolati erőforrásának kiépítési állapota.
systemData	systemData	A createdBy és a modifiedBy adatokat tartalmazó Azure Resource Manager-metaadatok.
type	string	Az erőforrás típusa. Pl. "Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionProvisioningState

Enumerálás

Az aktuális kiépítési állapot.

Érték	Description
Creating
Deleting
Failed
Succeeded

PrivateEndpointServiceConnectionStatus

Enumerálás

A privát végpont kapcsolatának állapota.

Érték	Description
Approved
Pending
Rejected

PrivateLinkServiceConnectionState

Objektum

A szolgáltatásfelhasználó és a szolgáltató közötti kapcsolat állapotával kapcsolatos információk gyűjteménye.

Name	Típus	Description
actionsRequired	string	Üzenet, amely jelzi, hogy a szolgáltató módosításaihoz szükség van-e a fogyasztó frissítésére.
description	string	A kapcsolat jóváhagyásának/elutasításának oka.
status	PrivateEndpointServiceConnectionStatus	Azt jelzi, hogy a szolgáltatás tulajdonosa jóváhagyta/elutasította/eltávolította-e a kapcsolatot.

ProvisioningState

Enumerálás

Az Azure Monitor-munkaterület kiépítési állapota. Ha minden rendben van, állítsa a Sikeres értékre.

Érték	Description
Canceled
Creating
Deleting
Failed
Succeeded

PublicNetworkAccess

Enumerálás

Lekérdezi vagy beállítja az Azure Monitor-munkaterület nyilvános hálózati hozzáférésének engedélyezését vagy letiltását

Érték	Description
Disabled
Enabled

systemData

Objektum

Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

Name	Típus	Description
createdAt	string (date-time)	Az erőforrás-létrehozás időbélyege (UTC).
createdBy	string	Az erőforrást létrehozó identitás.
createdByType	createdByType	Az erőforrást létrehozó identitás típusa.
lastModifiedAt	string (date-time)	Az erőforrás utolsó módosításának időbélyege (UTC)
lastModifiedBy	string	Az erőforrást legutóbb módosító identitás.
lastModifiedByType	createdByType	Az erőforrást legutóbb módosító identitás típusa.

Megosztás a következőn keresztül:

Azure Monitor Workspaces - List By Resource Group

URI-paraméterek

Válaszok

Biztonság

azure_auth

Hatókörök

Példák

List Azure Monitor Workspaces by resource group

Mintakérelem

Mintaválasz

Definíciók

AzureMonitorWorkspaceResource

AzureMonitorWorkspaceResourceListResult

createdByType

DefaultIngestionSettings

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

Metrics

PrivateEndpoint

PrivateEndpointConnection

PrivateEndpointConnectionProvisioningState

PrivateEndpointServiceConnectionStatus

PrivateLinkServiceConnectionState

ProvisioningState

PublicNetworkAccess

systemData