Api Version Set - Create Or Update

Creates or Updates a Api Version Set.

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

URI Parameters

Name In Required Type Description
resourceGroupName
path True

string

The name of the resource group.

serviceName
path True

string

The name of the API Management service.

Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True

string

Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

versionSetId
path True

string

Api Version Set identifier. Must be unique in the current API Management service instance.

Regex pattern: ^[^*#&+:<>?]+$

api-version
query True

string

Version of the API to be used with the client request.

Request Header

Name Required Type Description
If-Match

string

ETag of the Entity. Not required when creating an entity, but required when updating an entity.

Request Body

Name Required Type Description
properties.displayName True

string

Name of API Version Set

properties.versioningScheme True

versioningScheme

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

properties.description

string

Description of API Version Set.

properties.versionHeaderName

string

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

properties.versionQueryName

string

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

Responses

Name Type Description
200 OK

ApiVersionSetContract

Api Version Set was successfully updated.

Headers

ETag: string

201 Created

ApiVersionSetContract

Api Version Set was successfully created.

Headers

ETag: string

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

ApiManagementCreateApiVersionSet

Sample request

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

{
  "properties": {
    "displayName": "api set 1",
    "versioningScheme": "Segment",
    "description": "Version configuration"
  }
}

Sample response

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/api1",
  "type": "Microsoft.ApiManagement/service/api-version-sets",
  "name": "api1",
  "properties": {
    "displayName": "api set 1",
    "versioningScheme": "Segment",
    "description": "Version configuration"
  }
}
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/api1",
  "type": "Microsoft.ApiManagement/service/api-version-sets",
  "name": "api1",
  "properties": {
    "displayName": "api set 1",
    "versioningScheme": "Segment",
    "description": "Version configuration"
  }
}

Definitions

Name Description
ApiVersionSetContract

API Version Set Contract details.

ErrorFieldContract

Error Field contract.

ErrorResponse

Error Response.

versioningScheme

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

ApiVersionSetContract

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

Name of API Version Set

properties.versionHeaderName

string

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

properties.versionQueryName

string

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"

ErrorFieldContract

Error Field contract.

Name Type Description
code

string

Property level error code.

message

string

Human-readable representation of property-level error.

target

string

Property name.

ErrorResponse

Error Response.

Name Type Description
error.code

string

Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response.

error.details

ErrorFieldContract[]

The list of invalid fields send in request, in case of validation error.

error.message

string

Human-readable representation of the error.

versioningScheme

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

Name Type Description
Header

string

The API Version is passed in a HTTP header.

Query

string

The API Version is passed in a query parameter.

Segment

string

The API Version is passed in a path segment.