Microsoft Azure

Azure API Management: Apimprivatelink

Use these REST APIs for performing operations on Private Endpoint Connection in Azure API Management deployment.

Developer tools#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Use these REST APIs for performing operations on Private Endpoint Connection in Azure API Management deployment.

Endpoints 6

PrivateEndpointConnections

  • GETPrivateEndpointConnection_ListByService/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/privateEndpointConnectionsLists all private endpoint connections of the API Management service instance.
  • GETPrivateEndpointConnection_GetByName/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/privateEndpointConnections/:privateEndpointConnectionNameGets the details of the Private Endpoint Connection specified by its identifier.
  • PUTPrivateEndpointConnection_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/privateEndpointConnections/:privateEndpointConnectionNameCreates a new Private Endpoint Connection or updates an existing one.
  • DELETEPrivateEndpointConnection_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/privateEndpointConnections/:privateEndpointConnectionNameDeletes the specified Private Endpoint Connection.
  • GETPrivateEndpointConnection_ListPrivateLinkResources/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/privateLinkResourcesGets the private link resources
  • GETPrivateEndpointConnection_GetPrivateLinkResource/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/privateLinkResources/:privateLinkSubResourceNameGets the private link resources

API details

Base URL
https://management.azure.com
Authentication
OAuth 2.0 (implicit flow) with 1 scope
Operations
6 operations on 4 pathsGET 4PUT 1DELETE 1
Main resources
PrivateEndpointConnections 6
Response formats
application/json
Description format
Swagger 2.0, API version 2024-05-01

How to test the Azure API Management: Apimprivatelink in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Azure API Management: Apimprivatelink collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (implicit flow) with 1 scope. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “PrivateEndpointConnection_ListByService” (GET /subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/privateEndpointConnections), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Azure API Management: Apimprivatelink?

Use these REST APIs for performing operations on Private Endpoint Connection in Azure API Management deployment. It is listed under Developer tools and has 6 endpoints.

Who publishes the Azure API Management: Apimprivatelink?

It is listed from Microsoft Azure's public API description (an OpenAPI document), not published by Microsoft Azure on Swastik Codes. Anyone who controls azure.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Azure API Management: Apimprivatelink?

Requests go to https://management.azure.com. Endpoint paths are added to this base URL.

How do I authenticate with the Azure API Management: Apimprivatelink?

With OAuth 2.0 (implicit flow) with 1 scope.

How many endpoints does the Azure API Management: Apimprivatelink have?

6 operations on 4 paths (4 GET, 1 PUT, 1 DELETE). The largest groups are PrivateEndpointConnections.

Is forking the Azure API Management: Apimprivatelink free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.