Private Endpoint Connection - List Private Link Resources

Referência

Service:: API Management

API Version:: 2021-08-01

Obtém os recursos de link privado

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

Parâmetros de URI

Name	In	Required	Type	Description
resourceGroupName	path	True	string	O nome do grupo de recursos.
serviceName	path	True	string	O nome do serviço Gerenciamento de API. Regex pattern: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$`
subscriptionId	path	True	string	Credenciais de assinatura que identificam exclusivamente Microsoft Azure assinatura. A ID da assinatura faz parte do URI para cada chamada de serviço.
api-version	query	True	string	Versão da API a ser usada com a solicitação do cliente.

Respostas

Name	Type	Description
200 OK	PrivateLinkResourceListResult	OK
Other Status Codes	ErrorResponse	Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Azure Active Directory Flow OAuth2.

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

Scopes

Name	Description
user_impersonation	representar sua conta de usuário

Exemplos

ApiManagementListPrivateLinkGroupResources

Sample Request

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

Sample Response

Status code:: 200

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

Definições

ErrorFieldContract	Contrato de campo de erro.
ErrorResponse	Resposta de erro.
PrivateLinkResource	Um recurso de link privado
PrivateLinkResourceListResult	Uma lista de recursos de link privado

ErrorFieldContract

Contrato de campo de erro.

Name	Type	Description
code	string	Código de erro no nível da propriedade.
message	string	Representação legível por humanos de erro no nível da propriedade.
target	string	Nome da propriedade.

ErrorResponse

Resposta de erro.

Name	Type	Description
error.code	string	Código de erro definido pelo serviço. Esse código atua como um substatus do código de erro HTTP especificado na resposta.
error.details	ErrorFieldContract[]	A lista de campos inválidos enviada na solicitação, em caso de erro de validação.
error.message	string	Representação legível ao olho humano do erro.

PrivateLinkResource

Um recurso de link privado

Name	Type	Description
id	string	ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	O nome do recurso
properties.groupId	string	A ID do grupo de recursos de link privado.
properties.requiredMembers	string[]	O recurso de link privado exigiu nomes de membro.
properties.requiredZoneNames	string[]	O nome da zona DNS do link privado do link privado.
type	string	Tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft. Armazenamento/storageAccounts"

PrivateLinkResourceListResult

Uma lista de recursos de link privado

Name	Type	Description
value	PrivateLinkResource[]	Matriz de recursos de link privado