Share via

Api Version Set - List By Service

Service:
API Management
API Version:
2024-05-01

Lists a collection of API Version Sets in the specified service instance.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apiVersionSets?api-version=2024-05-01
With optional parameters: 
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apiVersionSets?$filter={$filter}&$top={$top}&$skip={$skip}&api-version=2024-05-01

URI Parameters

Name In Required Type Description
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

The name of the resource group. The name is case insensitive.
serviceName
 path True

string

minLength: 1
maxLength: 50
pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

The name of the API Management service.
subscriptionId
 path True

string (uuid)

The ID of the target subscription. The value must be an UUID.
api-version
 query True

string

minLength: 1

The API version to use for this operation.
$filter
 query

string

| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
$skip
 query

integer (int32)

minimum: 0

Number of records to skip.
$top
 query

integer (int32)

minimum: 1

Number of records to return.

Responses

Name Type Description
200 OK

ApiVersionSetCollection

Lists a collection of Api Version Set entities.
Other Status Codes

ErrorResponse

Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

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

Scopes

Name Description
user_impersonation impersonate your user account

Examples

ApiManagementListApiVersionSets

Sample request

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets?api-version=2024-05-01

Sample response

Status code:
200 
{
  "value": [
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/vs1",
      "type": "Microsoft.ApiManagement/service/api-version-sets",
      "name": "vs1",
      "properties": {
        "displayName": "api set 1",
        "versioningScheme": "Segment",
        "description": "Version configuration"
      }
    },
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/vs2",
      "type": "Microsoft.ApiManagement/service/api-version-sets",
      "name": "vs2",
      "properties": {
        "displayName": "api set 2",
        "versioningScheme": "Query",
        "description": "Version configuration 2"
      }
    }
  ],
  "count": 2,
  "nextLink": ""
}

Definitions

Name Description
ApiVersionSetCollection

Paged API Version Set list representation.
ApiVersionSetContract

API Version Set Contract details.
ErrorAdditionalInfo

The resource management error additional info.
ErrorDetail

The error detail.
ErrorResponse

Error response
versioningScheme

An value that determines where the API Version identifier will be located in a HTTP request.

ApiVersionSetCollection

Object

Paged API Version Set list representation.

Name Type Description
count

integer (int64)

Total record count number across all pages.
nextLink

string

Next page link if any.
value

ApiVersionSetContract[]

Page values.

ApiVersionSetContract

Object

API Version Set Contract details.

Name Type Description
id

string

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name

string

The name of the resource
properties.description

string

Description of API Version Set.
properties.displayName

string

minLength: 1
maxLength: 100

Name of API Version Set
properties.versionHeaderName

string

minLength: 1
maxLength: 100

Name of HTTP header parameter that indicates the API Version if versioningScheme is set to header.
properties.versionQueryName

string

minLength: 1
maxLength: 100

Name of query parameter that indicates the API Version if versioningScheme is set to query.
properties.versioningScheme

versioningScheme

An value that determines where the API Version identifier will be located in a HTTP request.
type

string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

ErrorAdditionalInfo

Object

The resource management error additional info.

Name Type Description
info

object

The additional info.
type

string

The additional info type.

ErrorDetail

Object

The error detail.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

The error additional info.
code

string

The error code.
details

ErrorDetail[]

The error details.
message

string

The error message.
target

string

The error target.

ErrorResponse

Object

Error response

Name Type Description
error

ErrorDetail

The error object.

versioningScheme

Enumeration

An value that determines where the API Version identifier will be located in a HTTP request.

Value Description
Segment

The API Version is passed in a path segment.
Query

The API Version is passed in a query parameter.
Header

The API Version is passed in a HTTP header.