Private Endpoint Connection - List Private Link Resources

Služba:

API Management

Verze rozhraní API:

2024-05-01

Získá prostředky privátního propojení.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Název služby API Management.
subscriptionId	path	True	string (uuid)	ID cílového předplatného. Hodnota musí být UUID.
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.

Odpovědi

Name	Typ	Description
200 OK	PrivateLinkResourceListResult	OK
Other Status Codes	ErrorResponse	Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok OAuth2 v Azure Active Directory

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

ApiManagementListPrivateLinkGroupResources

Ukázkový požadavek

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/privateLinkResources?api-version=2024-05-01

Ukázková odpověď

Stavový kód:

200

{
  "value": [
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/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"
        ]
      }
    }
  ]
}

Definice

Name	Description
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě.
ErrorResponse	Chybová odpověď
PrivateLinkResource	Prostředek privátního propojení
PrivateLinkResourceListResult	Seznam prostředků privátního propojení

ErrorAdditionalInfo

Objekt

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Další typ informací.

ErrorDetail

Objekt

Podrobnosti o chybě.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby.
details	ErrorDetail[]	Podrobnosti o chybě.
message	string	Chybová zpráva.
target	string	Cíl chyby.

ErrorResponse

Objekt

Chybová odpověď

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

PrivateLinkResource

Objekt

Prostředek privátního propojení

Name	Typ	Description
id	string	Plně kvalifikované ID prostředku pro prostředek. Příklad : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Název prostředku
properties.groupId	string	ID skupiny prostředků privátního propojení.
properties.requiredMembers	string[]	Prostředek privátního propojení vyžadoval názvy členů.
properties.requiredZoneNames	string[]	Název zóny DNS privátního propojení prostředku privátního propojení
type	string	Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

PrivateLinkResourceListResult

Objekt

Seznam prostředků privátního propojení

Name	Typ	Description
value	PrivateLinkResource[]	Pole prostředků privátního propojení