Data Collection Endpoints - Get

Referenz

Dienst:: Monitor

API-Version:: 2023-03-11

Gibt den angegebenen Datensammlungsendpunkt zurück.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionEndpoints/{dataCollectionEndpointName}?api-version=2023-03-11

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
dataCollectionEndpointName	path	True	string	Der Name des Datensammlungsendpunkts. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
subscriptionId	path	True	string minLength: 1	Die ID des Zielabonnements.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	DataCollectionEndpointResource	Anforderung erfolgreich abgeschlossen
Other Status Codes	ErrorResponseCommonV2	Fehler

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

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

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

Get data collection endpoint

Beispielanforderung

HTTP

GET https://management.azure.com/subscriptions/703362b3-f278-4e4b-9179-c76eaf41ffc2/resourceGroups/myResourceGroup/providers/Microsoft.Insights/dataCollectionEndpoints/myDataCollectionEndpoint?api-version=2023-03-11

Beispiel für eine Antwort

Statuscode:: 200

{
  "id": "/subscriptions/703362b3-f278-4e4b-9179-c76eaf41ffc2/resourceGroups/myResourceGroup/providers/Microsoft.Insights/dataCollectionEndpoints/myDataCollectionEndpoint",
  "name": "myDataCollectionEndpoint",
  "type": "Microsoft.Insights/dataCollectionEndpoints",
  "location": "eastus",
  "properties": {
    "immutableId": "dce-cd85a330eb664aa3bc7883cc394b0000",
    "configurationAccess": {
      "endpoint": "https://mydatacollectionendpoint-71ib.eastus-1.handler.control.monitor.azure.com"
    },
    "logsIngestion": {
      "endpoint": "https://mydatacollectionendpoint-71ib.eastus-1.ingest.monitor.azure.com"
    },
    "metricsIngestion": {
      "endpoint": "https://mydatacollectionendpoint-71ib.eastus-1.metrics.ingest.monitor.azure.com"
    },
    "networkAcls": {
      "publicNetworkAccess": "Enabled"
    },
    "provisioningState": "Succeeded"
  },
  "systemData": {
    "createdBy": "user1",
    "createdByType": "User",
    "createdAt": "2024-03-22T08:40:59.2431682Z",
    "lastModifiedBy": "user1",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-03-22T08:40:59.2431682Z"
  },
  "etag": "0000ae31-0000-0100-0000-65fd441c0000"
}

Definitionen

Name	Beschreibung
ConfigurationAccess	Der endpunkt, der von Clients für den Zugriff auf seine Konfiguration verwendet wird.
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
DataCollectionEndpointResource	Definition der Ressource auf ARM-Ebene der obersten Ebene.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponseCommonV2	Fehlerantwort
FailoverConfiguration	Failoverkonfiguration auf diesem Endpunkt. Diese Eigenschaft ist SCHREIBGESCHÜTZT.
Identity	Verwaltete Dienstidentität der Ressource.
KnownDataCollectionEndpointProvisioningState	Der Ressourcenbereitstellungsstatus. Diese Eigenschaft ist SCHREIBGESCHÜTZT.
KnownDataCollectionEndpointResourceKind	Die Art der Ressource.
KnownLocationSpecProvisioningStatus	Der Ressourcenbereitstellungsstatus an diesem Speicherort.
KnownPublicNetworkAccessOptions	Die Konfiguration, die festlegen soll, ob der Netzwerkzugriff von öffentlichen Internet auf die Endpunkte zulässig ist.
LocationSpec
LogsIngestion	Der Endpunkt, der von Clients zum Aufnehmen von Protokollen verwendet wird.
ManagedServiceIdentityType	Typ der verwalteten Dienstidentität (wobei systemAssigned- und UserAssigned-Typen zulässig sind).
Metadata	Metadaten für die Ressource. Diese Eigenschaft ist SCHREIBGESCHÜTZT.
MetricsIngestion	Der Endpunkt, der von Clients zum Aufnehmen von Metriken verwendet wird.
NetworkAcls	Regeln für die Netzwerkzugriffssteuerung für die Endpunkte.
PrivateLinkScopedResource
SystemData	Metadaten zur Erstellung und letzten Änderung der Ressource.
UserAssignedIdentity	Benutzer zugewiesene Identitätseigenschaften

ConfigurationAccess

Objekt

Der endpunkt, der von Clients für den Zugriff auf seine Konfiguration verwendet wird.

Name	Typ	Beschreibung
endpoint	string	Der Endpunkt. Diese Eigenschaft ist SCHREIBGESCHÜTZT.

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
Application
Key
ManagedIdentity
User

DataCollectionEndpointResource

Objekt

Definition der Ressource auf ARM-Ebene der obersten Ebene.

Name	Typ	Beschreibung
etag	string	Ressourcenentitätstag (ETag).
id	string	Vollqualifizierte ID der Ressource.
identity	Identity	Verwaltete Dienstidentität der Ressource.
kind	KnownDataCollectionEndpointResourceKind	Die Art der Ressource.
location	string	Der geografische Standort, an dem sich die Ressource befindet.
name	string	Der Name der Ressource.
properties.configurationAccess	ConfigurationAccess	Der endpunkt, der von Clients für den Zugriff auf seine Konfiguration verwendet wird.
properties.description	string	Beschreibung des Datensammlungsendpunkts.
properties.failoverConfiguration	FailoverConfiguration	Failoverkonfiguration auf diesem Endpunkt. Diese Eigenschaft ist SCHREIBGESCHÜTZT.
properties.immutableId	string	Die unveränderliche ID dieser Endpunktressource für die Datensammlung. Diese Eigenschaft ist SCHREIBGESCHÜTZT.
properties.logsIngestion	LogsIngestion	Der Endpunkt, der von Clients zum Aufnehmen von Protokollen verwendet wird.
properties.metadata	Metadata	Metadaten für die Ressource. Diese Eigenschaft ist SCHREIBGESCHÜTZT.
properties.metricsIngestion	MetricsIngestion	Der Endpunkt, der von Clients zum Aufnehmen von Metriken verwendet wird.
properties.networkAcls	NetworkAcls	Regeln für die Netzwerkzugriffssteuerung für die Endpunkte.
properties.privateLinkScopedResources	PrivateLinkScopedResource[]	Liste der Azure Monitor Private Link Scope Resources, der diese Endpunktressource für die Datensammlung zugeordnet ist. Diese Eigenschaft ist SCHREIBGESCHÜTZT.
properties.provisioningState	KnownDataCollectionEndpointProvisioningState	Der Ressourcenbereitstellungsstatus. Diese Eigenschaft ist SCHREIBGESCHÜTZT.
systemData	SystemData	Metadaten zur Erstellung und letzten Änderung der Ressource.
tags	object	Ressourcentags.
type	string	Der Typ der Ressource.

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

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

ErrorResponseCommonV2

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

FailoverConfiguration

Objekt

Failoverkonfiguration auf diesem Endpunkt. Diese Eigenschaft ist SCHREIBGESCHÜTZT.

Name	Typ	Beschreibung
activeLocation	string	Aktiver Ort, an dem der Datenfluss stattfindet.
locations	LocationSpec[]	Speicherorte, die für Failover konfiguriert sind.

Identity

Objekt

Verwaltete Dienstidentität der Ressource.

Name	Typ	Beschreibung
principalId	string (uuid)	Die Dienstprinzipal-ID der vom System zugewiesenen Identität. Diese Eigenschaft wird nur für eine vom System zugewiesene Identität bereitgestellt.
tenantId	string (uuid)	Die Mandanten-ID der vom System zugewiesenen Identität. Diese Eigenschaft wird nur für eine vom System zugewiesene Identität bereitgestellt.
type	ManagedServiceIdentityType	Typ der verwalteten Dienstidentität (wobei systemAssigned- und UserAssigned-Typen zulässig sind).
userAssignedIdentities	<string, UserAssignedIdentity>	User-Assigned Identitäten Die Gruppe der benutzerzuweisungen Identitäten, die der Ressource zugeordnet sind. Die Wörterbuchschlüssel "userAssignedIdentities" sind ARM-Ressourcen-IDs im Formular: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Die Wörterbuchwerte können leere Objekte ({}) in Anforderungen sein.

KnownDataCollectionEndpointProvisioningState

Enumeration

Der Ressourcenbereitstellungsstatus. Diese Eigenschaft ist SCHREIBGESCHÜTZT.

Wert	Beschreibung
Canceled
Creating
Deleting
Failed
Succeeded
Updating

KnownDataCollectionEndpointResourceKind

Enumeration

Die Art der Ressource.

Wert	Beschreibung
Linux
Windows

KnownLocationSpecProvisioningStatus

Enumeration

Der Ressourcenbereitstellungsstatus an diesem Speicherort.

Wert	Beschreibung
Canceled
Creating
Deleting
Failed
Succeeded
Updating

KnownPublicNetworkAccessOptions

Enumeration

Die Konfiguration, die festlegen soll, ob der Netzwerkzugriff von öffentlichen Internet auf die Endpunkte zulässig ist.

Wert	Beschreibung
Disabled
Enabled
SecuredByPerimeter

LocationSpec

Objekt

Name	Typ	Beschreibung
location	string	Name des Speicherorts.
provisioningStatus	KnownLocationSpecProvisioningStatus	Der Ressourcenbereitstellungsstatus an diesem Speicherort.

LogsIngestion

Objekt

Der Endpunkt, der von Clients zum Aufnehmen von Protokollen verwendet wird.

Name	Typ	Beschreibung
endpoint	string	Der Endpunkt. Diese Eigenschaft ist SCHREIBGESCHÜTZT.

ManagedServiceIdentityType

Enumeration

Typ der verwalteten Dienstidentität (wobei systemAssigned- und UserAssigned-Typen zulässig sind).

Wert	Beschreibung
None
SystemAssigned
SystemAssigned,UserAssigned
UserAssigned

Metadata

Objekt

Metadaten für die Ressource. Diese Eigenschaft ist SCHREIBGESCHÜTZT.

Name	Typ	Beschreibung
provisionedBy	string	Azure bietet die Verwaltung dieser Ressource im Auftrag des Kunden an.
provisionedByImmutableId	string	Unveränderliche ID des Azure-Angebots, das diese Ressource im Auftrag des Kunden verwaltet.
provisionedByResourceId	string	Ressourcen-ID von Azure, die diese Ressource im Auftrag des Kunden verwaltet.

MetricsIngestion

Objekt

Der Endpunkt, der von Clients zum Aufnehmen von Metriken verwendet wird.

Name	Typ	Beschreibung
endpoint	string	Der Endpunkt. Diese Eigenschaft ist SCHREIBGESCHÜTZT.

NetworkAcls

Objekt

Regeln für die Netzwerkzugriffssteuerung für die Endpunkte.

Name	Typ	Beschreibung
publicNetworkAccess	KnownPublicNetworkAccessOptions	Die Konfiguration, die festlegen soll, ob der Netzwerkzugriff von öffentlichen Internet auf die Endpunkte zulässig ist.

PrivateLinkScopedResource

Objekt

Name	Typ	Beschreibung
resourceId	string	The resourceId of the Azure Monitor Private Link Scope Scoped Resource through which this DCE is associated with a Azure Monitor Private Link Scope.
scopeId	string	Die unveränderliche ID der Azure Monitor Private Link Scope Resource, zu der die Zuordnung gehört.

SystemData

Objekt

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name	Typ	Beschreibung
createdAt	string (date-time)	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 (date-time)	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.

UserAssignedIdentity

Objekt

Benutzer zugewiesene Identitätseigenschaften

Name	Typ	Beschreibung
clientId	string (uuid)	Die Client-ID der zugewiesenen Identität.
principalId	string (uuid)	Die Prinzipal-ID der zugewiesenen Identität.

Freigeben über

Data Collection Endpoints - Get

URI-Parameter

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

Get data collection endpoint

Beispielanforderung

Beispiel für eine Antwort

Definitionen

ConfigurationAccess

createdByType

DataCollectionEndpointResource

ErrorAdditionalInfo

ErrorDetail

ErrorResponseCommonV2

FailoverConfiguration

Identity

KnownDataCollectionEndpointProvisioningState

KnownDataCollectionEndpointResourceKind

KnownLocationSpecProvisioningStatus

KnownPublicNetworkAccessOptions

LocationSpec

LogsIngestion

ManagedServiceIdentityType

Metadata

MetricsIngestion

NetworkAcls

PrivateLinkScopedResource

SystemData

UserAssignedIdentity

Zusätzliche Ressourcen