API Management Service API Version Sets [Microsoft.ApiManagement/service/apiVersionSets]

This module deploys an API Management Service API Version Set.

You can reference the module as follows:

module service './packages/api-management-service-api-version-sets/main.bicep' = {
  params: { (...) }
}

For examples, please refer to the Usage Examples section.

Navigation

• Resource Types
• Parameters
• Outputs
• Data Collection

Resource Types

Parameters

Required parameters

Conditional parameters

Optional parameters

Parameter: displayName

The display name of the API Version Set.

• Required: Yes
• Type: string

Parameter: versioningScheme

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

• Required: Yes
• Type: string
• Allowed:

  [
    'Header'
    'Query'
    'Segment'
  ]
  

Parameter: apiManagementServiceName

The name of the parent API Management service. Required if the template is used in a standalone deployment.

• Required: Yes
• Type: string

Parameter: description

Description of API Version Set.

• Required: No
• Type: string

Parameter: enableTelemetry

Enable/Disable usage telemetry for module.

• Required: No
• Type: bool
• Default: True

Parameter: name

API Version set name.

• Required: No
• Type: string
• Default: 'default'

Parameter: versionHeaderName

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

• Required: No
• Type: string

Parameter: versionQueryName

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

• Required: No
• Type: string

Outputs

Data Collection

The software may collect information about you and your use of the software and send it to Microsoft. Microsoft may use this information to provide services and improve our products and services. You may turn off the telemetry as described in the repository. There are also some features in the software that may enable you and Microsoft to collect data from users of your applications. If you use these features, you must comply with applicable law, including providing appropriate notices to users of your applications together with a copy of Microsoft's privacy statement. Our privacy statement is located at https://go.microsoft.com/fwlink/?LinkID=824704. You can learn more about data collection and use in the help documentation and our privacy statement. Your use of the software operates as your consent to these practices.