Share via

Workspace Api Version Set - Create Or Update

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

Creates or Updates a Api Version Set.

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

URI Parameters

Name In Required Type Description
resourceGroupName
 path True

string

The name of the resource group. The name is case insensitive.
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

uuid

The ID of the target subscription. The value must be an UUID.
versionSetId
 path True

string

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

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

string

Workspace identifier. Must be unique in the current API Management service instance.

Regex pattern: ^[^*#&+:<>?]+$
api-version
 query True

string

The API version to use for this operation.

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

ApiManagementCreateWorkspaceApiVersionSet

Sample request

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

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

Sample response

Status code:
200 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apiVersionSets/api1",
  "type": "Microsoft.ApiManagement/service/workspaces/api-version-sets",
  "name": "api1",
  "properties": {
    "displayName": "api set 1",
    "versioningScheme": "Segment",
    "description": "Version configuration"
  }
}
Status code:
201 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apiVersionSets/api1",
  "type": "Microsoft.ApiManagement/service/workspaces/api-version-sets",
  "name": "api1",
  "properties": {
    "displayName": "api set 1",
    "versioningScheme": "Segment",
    "description": "Version configuration"
  }
}

Definitions

Name Description
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.

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"

ErrorAdditionalInfo

The resource management error additional info.

Name Type Description
info

object

The additional info.
type

string

The additional info type.

ErrorDetail

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

Error response

Name Type Description
error

ErrorDetail

The error object.

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.