APIHub
Back to Explore

ApiManagementClient

Use these REST APIs for performing operations on the ApiVersionSet entity associated with your Azure API Management deployment. Using this entity you create and manage API Version Sets that are used to group APIs for consistent versioning.

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}/apiVersionSets

Lists a collection of API Version Sets 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 | |-------------|-------------|-------------|-------------|
  • $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}/apiVersionSets/{versionSetId}

Deletes specific Api Version Set.

  • resourceGroupName (path, required) — The name of the resource group.
  • serviceName (path, required) — The name of the API Management service.
  • versionSetId (path, required) — Api Version Set identifier. 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}/apiVersionSets/{versionSetId}

Gets the details of the Api Version Set specified by its identifier.

  • resourceGroupName (path, required) — The name of the resource group.
  • serviceName (path, required) — The name of the API Management service.
  • versionSetId (path, required) — Api Version Set identifier. 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}/apiVersionSets/{versionSetId}

Gets the entity state (Etag) version of the Api Version Set specified by its identifier.

  • resourceGroupName (path, required) — The name of the resource group.
  • serviceName (path, required) — The name of the API Management service.
  • versionSetId (path, required) — Api Version Set identifier. 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}/apiVersionSets/{versionSetId}

Updates the details of the Api VersionSet specified by its identifier.

  • resourceGroupName (path, required) — The name of the resource group.
  • serviceName (path, required) — The name of the API Management service.
  • versionSetId (path, required) — Api Version Set identifier. 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}/apiVersionSets/{versionSetId}

Creates or Updates a Api Version Set.

  • resourceGroupName (path, required) — The name of the resource group.
  • serviceName (path, required) — The name of the API Management service.
  • versionSetId (path, required) — Api Version Set identifier. 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.

6 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}/apiVersionSets"

management.azure.com · HTTPS only