Microsoft.ApiManagement service/workspaces/apiVersionSets

ARM template resource definition

The service/workspaces/apiVersionSets resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.ApiManagement/service/workspaces/apiVersionSets resource, add the following JSON to your template.

{
  "type": "Microsoft.ApiManagement/service/workspaces/apiVersionSets",
  "apiVersion": "2023-05-01-preview",
  "name": "string",
  "properties": {
    "description": "string",
    "displayName": "string",
    "versionHeaderName": "string",
    "versioningScheme": "string",
    "versionQueryName": "string"
  }
}

Property values

service/workspaces/apiVersionSets

Name Description Value
type The resource type 'Microsoft.ApiManagement/service/workspaces/apiVersionSets'
apiVersion The resource api version '2023-05-01-preview'
name The resource name

See how to set names and types for child resources in JSON ARM templates.
string (required)
properties API VersionSet contract properties. ApiVersionSetContractProperties

ApiVersionSetContractProperties

Name Description Value
description Description of API Version Set. string
displayName Name of API Version Set string (required)
versionHeaderName Name of HTTP header parameter that indicates the API Version if versioningScheme is set to header. string
versioningScheme An value that determines where the API Version identifier will be located in a HTTP request. 'Header'
'Query'
'Segment' (required)

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