Freigeben über


Private Endpoint Connections - Get

Dient zum Abrufen des Verbindungsobjekts für private Endpunkte.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AgFoodPlatform/farmBeats/{dataManagerForAgricultureResourceName}/privateEndpointConnections/{privateEndpointConnectionName}?api-version=2023-06-01-preview

URI-Parameter

Name In Erforderlich Typ Beschreibung
dataManagerForAgricultureResourceName
path True

string

Name der DataManagerForAgriculture-Ressource.

RegEx-Muster: ^[A-Za-z0-9]+(-[A-Za-z0-9]+)*$

privateEndpointConnectionName
path True

string

Name der Verbindung mit privatem Endpunkt.

resourceGroupName
path True

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

subscriptionId
path True

string

uuid

Hierbei handelt es sich um die ID des Zielabonnements. Der Wert muss eine UUID sein.

api-version
query True

string

Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Antworten

Name Typ Beschreibung
200 OK

PrivateEndpointConnection

Erfolg

404 Not Found

ErrorResponse

Nicht gefunden

Other Status Codes

ErrorResponse

Fehler

Sicherheit

azure_auth

Azure Active Directory OAuth2-Flow.

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

Bereiche

Name Beschreibung
user_impersonation Identitätswechsel Ihres Benutzerkontos

Beispiele

PrivateEndpointConnections_Get

Beispielanforderung

GET https://management.azure.com/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/examples-rg/providers/Microsoft.AgFoodPlatform/farmBeats/examples-farmbeatsResourceName/privateEndpointConnections/privateEndpointConnectionName?api-version=2023-06-01-preview

Beispiel für eine Antwort

{
  "id": "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/examples-rg/providers/Microsoft.AgFoodPlatform/farmBeats/examples-farmbeatsResourceName/privateEndpointConnections/privateEndpointConnectionName",
  "name": "privateEndpointConnectionName",
  "type": "Microsoft.AgFoodPlatform/farmBeats/privateEndpointConnections",
  "properties": {
    "privateEndpoint": {
      "id": "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/rg1Network/providers/Microsoft.Network/privateEndpoints/privateEndpointName"
    },
    "privateLinkServiceConnectionState": {
      "status": "Approved",
      "description": "Approved by johndoe@contoso.com",
      "actionsRequired": "None"
    },
    "provisioningState": "Succeeded"
  }
}
{
  "error": {
    "code": "PrivateEndpointConnectionNotFound",
    "message": "Private endpoint connection resource 'privateEndpointConnectionName' for subscriptionId '11111111-2222-3333-4444-555555555555', resource group name 'examples-rg', resource type 'farmBeats' and resource name 'examples-farmbeatsResourceName' not found."
  }
}

Definitionen

Name Beschreibung
createdByType

Der Identitätstyp, der die Ressource erstellt hat.

ErrorAdditionalInfo

Zusätzliche Informationen zum Ressourcenverwaltungsfehler.

ErrorDetail

Die Fehlerdetails.

ErrorResponse

Fehlerantwort

PrivateEndpoint

Die private Endpunktressource.

PrivateEndpointConnection

Die Verbindungsressource des privaten Endpunkts.

PrivateEndpointConnectionProvisioningState

Der aktuelle Bereitstellungsstatus.

PrivateEndpointServiceConnectionStatus

Die verbindung mit dem privaten Endpunkt status.

PrivateLinkServiceConnectionState

Eine Sammlung von Informationen über den Verbindungsstatus zwischen Dienstconsumer und Anbieter.

systemData

Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

Name Typ Beschreibung
Application

string

Key

string

ManagedIdentity

string

User

string

ErrorAdditionalInfo

Zusätzliche Informationen zum Ressourcenverwaltungsfehler.

Name Typ Beschreibung
info

object

Zusätzliche Informationen.

type

string

Typ der zusätzlichen Informationen.

ErrorDetail

Die Fehlerdetails.

Name Typ Beschreibung
additionalInfo

ErrorAdditionalInfo[]

Die zusätzlichen Fehlerinformationen.

code

string

Der Fehlercode.

details

ErrorDetail[]

Die Fehlerdetails.

message

string

Die Fehlermeldung.

target

string

Das Fehlerziel.

ErrorResponse

Fehlerantwort

Name Typ Beschreibung
error

ErrorDetail

Das Fehlerobjekt.

PrivateEndpoint

Die private Endpunktressource.

Name Typ Beschreibung
id

string

Der ARM-Bezeichner für den privaten Endpunkt.

PrivateEndpointConnection

Die Verbindungsressource des privaten Endpunkts.

Name Typ Beschreibung
id

string

Vollqualifizierte Ressourcen-ID für die Ressource. Beispiel: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

name

string

Der Name der Ressource

properties.groupIds

string[]

Die Gruppen-IDs für die private Endpunktressource.

properties.privateEndpoint

PrivateEndpoint

Die private Endpunktressource.

properties.privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

Eine Sammlung von Informationen über den Verbindungsstatus zwischen Dienstconsumer und Anbieter.

properties.provisioningState

PrivateEndpointConnectionProvisioningState

Der Bereitstellungsstatus der Verbindungsressource des privaten Endpunkts.

systemData

systemData

Azure Resource Manager-Metadaten mit createdBy- und modifiedBy-Informationen.

type

string

Der Typ der Ressource. Z.B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionProvisioningState

Der aktuelle Bereitstellungsstatus.

Name Typ Beschreibung
Creating

string

Deleting

string

Failed

string

Succeeded

string

PrivateEndpointServiceConnectionStatus

Die verbindung mit dem privaten Endpunkt status.

Name Typ Beschreibung
Approved

string

Pending

string

Rejected

string

PrivateLinkServiceConnectionState

Eine Sammlung von Informationen über den Verbindungsstatus zwischen Dienstconsumer und Anbieter.

Name Typ Beschreibung
actionsRequired

string

Eine Meldung, die angibt, ob Änderungen am Dienstanbieter Updates für den Consumer 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

Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

Name Typ Beschreibung
createdAt

string

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

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.