APIHub
Back to Explore

ApiManagementClient

Use these REST APIs for performing operations on Backend entity in Azure API Management deployment. The Backend entity in API Management represents a backend service that is configured to skip certification chain validation when using a self-signed certificate to test mutual certificate authentication.

Cloud
OAuth
HTTPS
CORS: Unknown
Visit official documentation

Latency

Not monitored yet

Uptime

Not monitored yet

Playground

Verified

live

Endpoints

REST · JSON
GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/backends

Lists a collection of backends in the specified service instance.

  • resourceGroupName (path, required) — The name of the resource group.
  • serviceName (path, required) — The name of the API Management service.
  • $filter (query) — | Field | Usage | Supported operators | Supported functions | |-------------|-------------|-------------|-------------| | name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | title | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | url | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
  • $top (query, limit) — Number of records to return.
  • $skip (query, offset) — Number of records to skip.
  • api-version (query, required) — Version of the API to be used with the client request.
  • subscriptionId (path, required) — Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
DELETE

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/backends/{backendId}

Deletes the specified backend.

  • resourceGroupName (path, required) — The name of the resource group.
  • serviceName (path, required) — The name of the API Management service.
  • backendId (path, required) — Identifier of the Backend entity. Must be unique in the current API Management service instance.
  • If-Match (header, required) — ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
  • api-version (query, required) — Version of the API to be used with the client request.
  • subscriptionId (path, required) — Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/backends/{backendId}

Gets the details of the backend specified by its identifier.

  • resourceGroupName (path, required) — The name of the resource group.
  • serviceName (path, required) — The name of the API Management service.
  • backendId (path, required) — Identifier of the Backend entity. Must be unique in the current API Management service instance.
  • api-version (query, required) — Version of the API to be used with the client request.
  • subscriptionId (path, required) — Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
HEAD

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/backends/{backendId}

Gets the entity state (Etag) version of the backend specified by its identifier.

  • resourceGroupName (path, required) — The name of the resource group.
  • serviceName (path, required) — The name of the API Management service.
  • backendId (path, required) — Identifier of the Backend entity. Must be unique in the current API Management service instance.
  • api-version (query, required) — Version of the API to be used with the client request.
  • subscriptionId (path, required) — Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
PATCH

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/backends/{backendId}

Updates an existing backend.

  • resourceGroupName (path, required) — The name of the resource group.
  • serviceName (path, required) — The name of the API Management service.
  • backendId (path, required) — Identifier of the Backend entity. Must be unique in the current API Management service instance.
  • If-Match (header, required) — ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
  • api-version (query, required) — Version of the API to be used with the client request.
  • subscriptionId (path, required) — Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
PUT

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/backends/{backendId}

Creates or Updates a backend.

  • resourceGroupName (path, required) — The name of the resource group.
  • serviceName (path, required) — The name of the API Management service.
  • backendId (path, required) — Identifier of the Backend entity. Must be unique in the current API Management service instance.
  • If-Match (header) — ETag of the Entity. Not required when creating an entity, but required when updating an entity.
  • api-version (query, required) — Version of the API to be used with the client request.
  • subscriptionId (path, required) — Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
POST

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/backends/{backendId}/reconnect

Notifies the APIM proxy to create a new connection to the backend after the specified timeout. If no timeout was specified, timeout of 2 minutes is used.

  • resourceGroupName (path, required) — The name of the resource group.
  • serviceName (path, required) — The name of the API Management service.
  • backendId (path, required) — Identifier of the Backend entity. Must be unique in the current API Management service instance.
  • api-version (query, required) — Version of the API to be used with the client request.
  • subscriptionId (path, required) — Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

7 endpoints auto-detected

Authentication

This API requires authentication: OAuth.

curl -X GET \
  "https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/backends"

management.azure.com · HTTPS only