Private Endpoint Connection - Get Private Link Resource

Obtiene los recursos de vínculo privado.

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

Parámetros de identificador URI

Name In Required Type Description
privateLinkSubResourceName
path True
  • string

Nombre del recurso de vínculo privado.

resourceGroupName
path True
  • string

Nombre del grupo de recursos.

serviceName
path True
  • string

Nombre del servicio API Management.

Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True
  • string

Credenciales de suscripción que identifican de forma única la suscripción de Microsoft Azure. El identificador de suscripción forma parte del URI para cada llamada al servicio.

api-version
query True
  • string

Versión de la API que se va a usar con la solicitud de cliente.

Respuestas

Name Type Description
200 OK

Aceptar

Other Status Codes

Respuesta de error que describe el motivo del error de la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation suplantar la cuenta de usuario

Ejemplos

ApiManagementGetPrivateLinkGroupResource

Sample Request

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

Sample Response

{
  "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"
    ]
  }
}

Definiciones

ErrorFieldContract

Contrato de campo de error.

ErrorResponse

Respuesta de error.

PrivateLinkResource

Un recurso de vínculo privado

ErrorFieldContract

Contrato de campo de error.

Name Type Description
code
  • string

Código de error de nivel de propiedad.

message
  • string

Representación legible del error de nivel de propiedad.

target
  • string

Nombre de propiedad.

ErrorResponse

Respuesta de error.

Name Type Description
error.code
  • string

Código del error definido por el servicio. Este código funciona como estado secundario del código de error HTTP especificado en la respuesta.

error.details

La lista de campos no válidos que se envían en la solicitud, en caso de error de validación.

error.message
  • string

Representación legible del error.

PrivateLinkResource

Un recurso de vínculo privado

Name Type Description
id
  • string

Identificador de recurso completo del recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name
  • string

Nombre del recurso.

properties.groupId
  • string

Identificador del grupo de recursos de vínculo privado.

properties.requiredMembers
  • string[]

Los nombres de miembro necesarios para el recurso private link.

properties.requiredZoneNames
  • string[]

El recurso private link Nombre de la zona DNS de Private Link.

type
  • string

Tipo de recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"