Freigeben über


Private Endpoint Connection - Get Private Link Resource

Ruft die Private Link-Ressourcen ab.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/privateLinkResources/{privateLinkSubResourceName}?api-version=2022-08-01

URI-Parameter

Name In Erforderlich Typ Beschreibung
privateLinkSubResourceName
path True

string

Name der Private Link-Ressource.

resourceGroupName
path True

string

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

serviceName
path True

string

Der Name des API Management-Diensts.

RegEx-Muster: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True

string

Hierbei handelt es sich um die ID des Zielabonnements.

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

PrivateLinkResource

OK

Other Status Codes

ErrorResponse

Fehlerantwort mit Beschreibung des Grunds für den 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

ApiManagementGetPrivateLinkGroupResource

Beispielanforderung

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/privateLinkResources/privateLinkSubResourceName?api-version=2022-08-01

Beispiel für eine Antwort

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/privateLinkResources/Gateway",
  "name": "Gateway",
  "type": "Microsoft.ApiManagement/service/privateLinkResources",
  "properties": {
    "groupId": "Gateway",
    "requiredMembers": [
      "Gateway"
    ],
    "requiredZoneNames": [
      "privateLink.azure-api.net"
    ]
  }
}

Definitionen

Name Beschreibung
ErrorFieldContract

Fehler Feldvertrag.

ErrorResponse

Fehlerantwort.

PrivateLinkResource

Eine Private Link-Ressource

ErrorFieldContract

Fehler Feldvertrag.

Name Typ Beschreibung
code

string

Fehlercode auf Eigenschaftsebene.

message

string

Für Menschen lesbare Darstellung eines Fehlers auf Eigenschaftsebene.

target

string

Der Eigenschaftsname.

ErrorResponse

Fehlerantwort.

Name Typ Beschreibung
error.code

string

Der vom Dienst definierte Fehlercode. Dieser Code dient als Unterstatus für den in der Antwort angegebenen HTTP-Fehlercode.

error.details

ErrorFieldContract[]

Die Liste der ungültigen Felder, die in der Anforderung gesendet werden, im Falle eines Validierungsfehlers.

error.message

string

Lesbare Darstellung des Fehlers.

PrivateLinkResource

Eine Private Link-Ressource

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.groupId

string

Die Private Link-Ressourcengruppen-ID.

properties.requiredMembers

string[]

Die Private Link-Ressource erforderte Membernamen.

properties.requiredZoneNames

string[]

Der Dns-Zonenname der Private Link-Ressource.

type

string

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