Private Link Scopes - List By Resource Group

Dienst:

Monitor

API-Version:

2021-09-01

Ruft eine Liste von Azure Monitor PrivateLinkScopes innerhalb einer Ressourcengruppe ab.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/privateLinkScopes?api-version=2021-09-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
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	AzureMonitorPrivateLinkScopeListResult	Eine Liste mit 0 oder mehr Azure Monitor PrivateLinkScope-Definitionen.
Other Status Codes	ErrorResponse	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

PrivateLinkScopeListByResourceGroup

Beispielanforderung

HTTP

GET https://management.azure.com/subscriptions/86dc51d3-92ed-4d7e-947a-775ea79b4919/resourceGroups/my-resource-group/providers/Microsoft.Insights/privateLinkScopes?api-version=2021-09-01

Beispiel für eine Antwort

Statuscode:

200

{
  "value": [
    {
      "id": "/subscriptions/86dc51d3-92ed-4d7e-947a-775ea79b4919/resourceGroups/my-resource-group/providers/microsoft.insights/privateLinkScopes/my-privatelinkscope",
      "name": "my-privatelinkscope",
      "type": "Microsoft.Insights/privateLinkScopes",
      "location": "Global",
      "tags": {},
      "systemData": {
        "createdBy": "bobby@contoso.com",
        "createdByType": "User",
        "createdAt": "2021-06-16T12:59:57.051056Z",
        "lastModifiedBy": "bobby@contoso.com",
        "lastModifiedByType": "User",
        "lastModifiedAt": "2021-06-16T12:59:57.051056Z"
      },
      "properties": {
        "provisioningState": "Succeeded",
        "accessModeSettings": {
          "queryAccessMode": "Open",
          "ingestionAccessMode": "Open",
          "exclusions": []
        }
      }
    },
    {
      "id": "/subscriptions/86dc51d3-92ed-4d7e-947a-775ea79b4919/resourceGroups/my-resource-group/providers/microsoft.insights/privateLinkScopes/my-other-privatelinkscope",
      "name": "my-other-privatelinkscope",
      "type": "Microsoft.Insights/privateLinkScopes",
      "location": "Global",
      "tags": {},
      "systemData": {
        "createdBy": "bobby@contoso.com",
        "createdByType": "User",
        "createdAt": "2021-06-16T12:59:57.051056Z",
        "lastModifiedBy": "bobby@contoso.com",
        "lastModifiedByType": "User",
        "lastModifiedAt": "2021-06-16T12:59:57.051056Z"
      },
      "properties": {
        "provisioningState": "Succeeded",
        "accessModeSettings": {
          "queryAccessMode": "Open",
          "ingestionAccessMode": "Open",
          "exclusions": []
        }
      }
    }
  ],
  "nextLink": null
}

Definitionen

Name	Beschreibung
AccessMode	Zugriffsmodustypen.
AccessModeSettings	Eigenschaften, die die Einstellungen für den privaten Verknüpfungsmodus des Bereichs definieren.
AccessModeSettingsExclusion	Eigenschaften, die das Ausschlusselement für den Privaten Verknüpfungsmodus des Bereichs definieren. Diese Einstellung gilt für eine bestimmte private Endpunktverbindung und überschreibt die Standardeinstellungen für diese private Endpunktverbindung.
AzureMonitorPrivateLinkScope	Eine Azure Monitor PrivateLinkScope-Definition.
AzureMonitorPrivateLinkScopeListResult	Beschreibt die Liste der Azure Monitor PrivateLinkScope-Ressourcen.
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
PrivateEndpoint	Die Private Endpoint-Ressource.
PrivateEndpointConnection	Die Private Endpoint Connection-Ressource.
PrivateEndpointConnectionProvisioningState	Der aktuelle Bereitstellungsstatus.
PrivateEndpointServiceConnectionStatus	Der Status der privaten Endpunktverbindung.
PrivateLinkServiceConnectionState	Eine Sammlung von Informationen über den Status der Verbindung zwischen Service Consumer und Provider.
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.

AccessMode

Enumeration

Zugriffsmodustypen.

Wert	Beschreibung
Open
PrivateOnly

AccessModeSettings

Objekt

Eigenschaften, die die Einstellungen für den privaten Verknüpfungsmodus des Bereichs definieren.

Name	Typ	Beschreibung
exclusions	AccessModeSettingsExclusion[]	Liste der Ausschlüsse, die die Standardzugriffsmoduseinstellungen für bestimmte private Endpunktverbindungen außer Kraft setzen.
ingestionAccessMode	AccessMode	Gibt den Standardzugriffsmodus der Erfassung über zugeordnete private Endpunkte im Bereich an. Wenn der Standardwert nicht angegeben ist, lautet 'Open'. Sie können diese Standardeinstellung für eine bestimmte private Endpunktverbindung außer Kraft setzen, indem Sie einen Ausschluss im Array "Ausschlüsse" hinzufügen.
queryAccessMode	AccessMode	Gibt den Standardzugriffsmodus von Abfragen über zugeordnete private Endpunkte im Bereich an. Wenn der Standardwert nicht angegeben ist, lautet 'Open'. Sie können diese Standardeinstellung für eine bestimmte private Endpunktverbindung außer Kraft setzen, indem Sie einen Ausschluss im Array "Ausschlüsse" hinzufügen.

AccessModeSettingsExclusion

Objekt

Eigenschaften, die das Ausschlusselement für den Privaten Verknüpfungsmodus des Bereichs definieren. Diese Einstellung gilt für eine bestimmte private Endpunktverbindung und überschreibt die Standardeinstellungen für diese private Endpunktverbindung.

Name	Typ	Beschreibung
ingestionAccessMode	AccessMode	Gibt den Zugriffsmodus der Erfassung über die angegebene private Endpunktverbindung im Ausschluss an.
privateEndpointConnectionName	string	Der Name der privaten Endpunktverbindung, der dem privaten Endpunkt zugeordnet ist, auf den wir die spezifischen Zugriffsmoduseinstellungen anwenden möchten.
queryAccessMode	AccessMode	Gibt den Zugriffsmodus von Abfragen über die angegebene private Endpunktverbindung im Ausschluss an.

AzureMonitorPrivateLinkScope

Objekt

Eine Azure Monitor PrivateLinkScope-Definition.

Name	Typ	Beschreibung
id	string	Vollqualifizierte Ressourcen-ID für die Ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Der geografische Standort, an dem sich die Ressource befindet
name	string	Der Name der Ressource
properties.accessModeSettings	AccessModeSettings	Zugriffsmoduseinstellungen
properties.privateEndpointConnections	PrivateEndpointConnection[]	Liste der privaten Endpunktverbindungen.
properties.provisioningState	string	Aktueller Status dieses PrivateLinkScope: Gibt an, ob es innerhalb der Ressourcengruppe bereitgestellt wurde, die sie definiert hat. Benutzer können diesen Wert nicht ändern, können aber daraus lesen. Die Werte umfassen die Bereitstellung ,Erfolgreich, abgebrochen und fehlgeschlagen.
systemData	systemData	Systemdaten
tags	object	Ressourcentags.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

AzureMonitorPrivateLinkScopeListResult

Objekt

Beschreibt die Liste der Azure Monitor PrivateLinkScope-Ressourcen.

Name	Typ	Beschreibung
nextLink	string	Der URI, um den nächsten Satz von Azure Monitor PrivateLinkScope-Definitionen abzurufen, wenn zu viele PrivateLinkScopes, die im Resultset zurückgegeben wurden.
value	AzureMonitorPrivateLinkScope[]	Liste der Azure Monitor PrivateLinkScope-Definitionen.

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
User
Application
ManagedIdentity
Key

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.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

PrivateEndpoint

Objekt

Die Private Endpoint-Ressource.

Name	Typ	Beschreibung
id	string	Der ARM-Bezeichner für private Endpunkte

PrivateEndpointConnection

Objekt

Die Private Endpoint Connection-Ressource.

Name	Typ	Beschreibung
id	string	Vollqualifizierte Ressourcen-ID für die Ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Der Name der Ressource
properties.privateEndpoint	PrivateEndpoint	Die Ressource des privaten Endpunkts.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Eine Sammlung von Informationen über den Status der Verbindung zwischen Service Consumer und Provider.
properties.provisioningState	PrivateEndpointConnectionProvisioningState	Der Bereitstellungsstatus der privaten Endpunktverbindungsressource.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionProvisioningState

Enumeration

Der aktuelle Bereitstellungsstatus.

Wert	Beschreibung
Succeeded
Creating
Deleting
Failed

PrivateEndpointServiceConnectionStatus

Enumeration

Der Status der privaten Endpunktverbindung.

Wert	Beschreibung
Pending
Approved
Rejected

PrivateLinkServiceConnectionState

Objekt

Eine Sammlung von Informationen über den Status der Verbindung zwischen Service Consumer und Provider.

Name	Typ	Beschreibung
actionsRequired	string	Eine Meldung, die angibt, ob Änderungen am Dienstanbieter Updates für den Verbraucher 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.

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.