Azure Monitor Workspaces - List By Resource Group

Servicio:: Monitor

Versión de la API:: 2023-04-03

Enumera todas las áreas de trabajo de Azure Monitor en el grupo de recursos especificado.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.
subscriptionId	path	True	string minLength: 1	Identificador de la suscripción de destino.
api-version	query	True	string minLength: 1	Versión de la API que se va a usar para esta operación.

Respuestas

Nombre	Tipo	Description
200 OK	AzureMonitorWorkspaceResourceListResult	Solicitud completada correctamente
Other Status Codes	ErrorResponse	Error

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

List Azure Monitor Workspaces by resource group

Solicitud de ejemplo

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

Respuesta de muestra

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
}

Definiciones

Nombre	Description
AzureMonitorWorkspaceResource	Una definición del área de trabajo de Azure Monitor
AzureMonitorWorkspaceResourceListResult	Una lista paginable de recursos
createdByType	Tipo de identidad que creó el recurso.
DefaultIngestionSettings	Regla de recopilación de datos y punto de conexión que se usa para la ingesta de forma predeterminada.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
Metrics	Propiedades relacionadas con el contenedor de métricas en el área de trabajo de Azure Monitor
PrivateEndpoint	Recurso de punto de conexión privado.
PrivateEndpointConnection	Recurso de conexión de punto de conexión privado.
PrivateEndpointConnectionProvisioningState	Estado de aprovisionamiento actual.
PrivateEndpointServiceConnectionStatus	Estado de conexión del punto de conexión privado.
PrivateLinkServiceConnectionState	Colección de información sobre el estado de la conexión entre el consumidor del servicio y el proveedor.
ProvisioningState	Estado de aprovisionamiento del área de trabajo de Azure Monitor. Establezca en Correcto si todo está en buen estado.
PublicNetworkAccess	Obtiene o establece permitir o denegar el acceso de red pública al área de trabajo de Azure Monitor.
systemData	Metadatos relativos a la creación y última modificación del recurso.

AzureMonitorWorkspaceResource

Object

Una definición del área de trabajo de Azure Monitor

Nombre	Tipo	Description
etag	string	Etiqueta de entidad de recurso (ETag)
id	string (arm-id)	Identificador de recurso completo para el recurso. Por ejemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location	string	Ubicación geográfica donde reside el recurso
name	string	Nombre del recurso
properties.accountId	string	Identificador inmutable del área de trabajo de Azure Monitor. Esta propiedad es de sólo lectura.
properties.defaultIngestionSettings	DefaultIngestionSettings	Regla de recopilación de datos y punto de conexión que se usa para la ingesta de forma predeterminada.
properties.metrics	Metrics	Propiedades relacionadas con el contenedor de métricas en el área de trabajo de Azure Monitor
properties.privateEndpointConnections	PrivateEndpointConnection[]	Lista de conexiones de punto de conexión privado
properties.provisioningState	ProvisioningState	Estado de aprovisionamiento del área de trabajo de Azure Monitor. Establezca en Correcto si todo está en buen estado.
properties.publicNetworkAccess	PublicNetworkAccess	Obtiene o establece permitir o denegar el acceso de red pública al área de trabajo de Azure Monitor.
systemData	systemData	Metadatos de Azure Resource Manager que contienen información createdBy y modifiedBy.
tags	object	Etiquetas de recursos.
type	string	Tipo del recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

AzureMonitorWorkspaceResourceListResult

Object

Una lista paginable de recursos

Nombre	Tipo	Description
nextLink	string	Dirección URL que se va a usar para obtener el siguiente conjunto de resultados
value	AzureMonitorWorkspaceResource[]	Lista de recursos

createdByType

Enumeración

Tipo de identidad que creó el recurso.

Valor	Description
Application
Key
ManagedIdentity
User

DefaultIngestionSettings

Object

Regla de recopilación de datos y punto de conexión que se usa para la ingesta de forma predeterminada.

Nombre	Tipo	Description
dataCollectionEndpointResourceId	string	Identificador de recurso de Azure del punto de conexión de recopilación de datos predeterminado para este área de trabajo de Azure Monitor.
dataCollectionRuleResourceId	string	Identificador de recurso de Azure de la regla de recopilación de datos predeterminada para esta área de trabajo de Azure Monitor.

ErrorAdditionalInfo

Object

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Object

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Detalles del error.
message	string	Mensaje de error.
target	string	Destino del error.

ErrorResponse

Object

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

Metrics

Object

Propiedades relacionadas con el contenedor de métricas en el área de trabajo de Azure Monitor

Nombre	Tipo	Description
internalId	string	Identificador interno del contenedor de métricas. Solo para ser utilizado por el sistema
prometheusQueryEndpoint	string	Punto de conexión de consulta de Prometheus para el área de trabajo de Azure Monitor

PrivateEndpoint

Object

Recurso de punto de conexión privado.

Nombre	Tipo	Description
id	string	Identificador de ARM para el punto de conexión privado.

PrivateEndpointConnection

Object

Recurso de conexión de punto de conexión privado.

Nombre	Tipo	Description
id	string (arm-id)	Identificador de recurso completo para el recurso. Por ejemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Nombre del recurso
properties.groupIds	string[]	Identificadores de grupo para el recurso de punto de conexión privado.
properties.privateEndpoint	PrivateEndpoint	Recurso de punto de conexión privado.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Colección de información sobre el estado de la conexión entre el consumidor del servicio y el proveedor.
properties.provisioningState	PrivateEndpointConnectionProvisioningState	Estado de aprovisionamiento del recurso de conexión de punto de conexión privado.
systemData	systemData	Metadatos de Azure Resource Manager que contienen información createdBy y modifiedBy.
type	string	Tipo del recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionProvisioningState

Enumeración

Estado de aprovisionamiento actual.

Valor	Description
Creating
Deleting
Failed
Succeeded

PrivateEndpointServiceConnectionStatus

Enumeración

Estado de conexión del punto de conexión privado.

Valor	Description
Approved
Pending
Rejected

PrivateLinkServiceConnectionState

Object

Colección de información sobre el estado de la conexión entre el consumidor del servicio y el proveedor.

Nombre	Tipo	Description
actionsRequired	string	Mensaje que indica si los cambios en el proveedor de servicios requieren actualizaciones en el consumidor.
description	string	Motivo de aprobación o rechazo de la conexión.
status	PrivateEndpointServiceConnectionStatus	Indica si el propietario del servicio ha aprobado o rechazado o eliminado la conexión.

ProvisioningState

Enumeración

Estado de aprovisionamiento del área de trabajo de Azure Monitor. Establezca en Correcto si todo está en buen estado.

Valor	Description
Canceled
Creating
Deleting
Failed
Succeeded

PublicNetworkAccess

Enumeración

Obtiene o establece permitir o denegar el acceso de red pública al área de trabajo de Azure Monitor.

Valor	Description
Disabled
Enabled

systemData

Object

Metadatos relativos a la creación y última modificación del recurso.

Nombre	Tipo	Description
createdAt	string (date-time)	Marca de tiempo de creación de recursos (UTC).
createdBy	string	Identidad que creó el recurso.
createdByType	createdByType	Tipo de identidad que creó el recurso.
lastModifiedAt	string (date-time)	Marca de tiempo de la última modificación del recurso (UTC)
lastModifiedBy	string	Identidad que modificó por última vez el recurso.
lastModifiedByType	createdByType	Tipo de identidad que modificó por última vez el recurso.

Compartir a través de

Azure Monitor Workspaces - List By Resource Group

Parámetros de identificador URI

Respuestas

Seguridad

azure_auth

Ámbitos

Ejemplos

List Azure Monitor Workspaces by resource group

Solicitud de ejemplo

Respuesta de muestra

Definiciones

AzureMonitorWorkspaceResource

AzureMonitorWorkspaceResourceListResult

createdByType

DefaultIngestionSettings

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

Metrics

PrivateEndpoint

PrivateEndpointConnection

PrivateEndpointConnectionProvisioningState

PrivateEndpointServiceConnectionStatus

PrivateLinkServiceConnectionState

ProvisioningState

PublicNetworkAccess

systemData