Microsoft.ApiManagement service/apiVersionSets

The service/apiVersionSets resource type can be deployed to: Resource groups.

To learn about resource group deployments, see Bicep or ARM template.

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

Template format

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

resource symbolicname 'Microsoft.ApiManagement/service/apiVersionSets@2021-12-01-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    description: 'string'
    displayName: 'string'
    versionHeaderName: 'string'
    versioningScheme: 'string'
    versionQueryName: 'string'
  }
}

Property values

service/apiVersionSets

Name Description Value
type The resource type

For Bicep, set this value in the resource declaration.
'Microsoft.ApiManagement/service/apiVersionSets'
apiVersion The resource api version

For Bicep, set this value in the resource declaration.
'2021-12-01-preview'
name The resource name

See how to set names and types for child resources in Bicep or JSON ARM templates.
string (required)
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.
Symbolic name for resource of type: service
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'
versionQueryName Name of query parameter that indicates the API Version if versioningScheme is set to query. string