Microsoft.ApiManagement service/apiVersionSets
Bicep resource definition
The service/apiVersionSets resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.ApiManagement/service/apiVersionSets resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.ApiManagement/service/apiVersionSets@2023-09-01-preview' = {
name: 'string'
parent: resourceSymbolicName
properties: {
description: 'string'
displayName: 'string'
versionHeaderName: 'string'
versioningScheme: 'string'
versionQueryName: 'string'
}
}
Property values
service/apiVersionSets
| Name | Description | Value |
|---|---|---|
| name | The resource name See how to set names and types for child resources in Bicep. |
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) Constraints: Min length = 1 Max length = 100 |
| versionHeaderName | Name of HTTP header parameter that indicates the API Version if versioningScheme is set to header. |
string Constraints: Min length = 1 Max length = 100 |
| 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 Constraints: Min length = 1 Max length = 100 |
ARM template resource definition
The service/apiVersionSets resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.ApiManagement/service/apiVersionSets resource, add the following JSON to your template.
{
"type": "Microsoft.ApiManagement/service/apiVersionSets",
"apiVersion": "2023-09-01-preview",
"name": "string",
"properties": {
"description": "string",
"displayName": "string",
"versionHeaderName": "string",
"versioningScheme": "string",
"versionQueryName": "string"
}
}
Property values
service/apiVersionSets
| Name | Description | Value |
|---|---|---|
| type | The resource type | 'Microsoft.ApiManagement/service/apiVersionSets' |
| apiVersion | The resource api version | '2023-09-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) Constraints: Min length = 1 Max length = 100 |
| versionHeaderName | Name of HTTP header parameter that indicates the API Version if versioningScheme is set to header. |
string Constraints: Min length = 1 Max length = 100 |
| 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 Constraints: Min length = 1 Max length = 100 |
Terraform (AzAPI provider) resource definition
The service/apiVersionSets resource type can be deployed with operations that target:
- Resource groups
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.ApiManagement/service/apiVersionSets resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/apiVersionSets@2023-09-01-preview"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
description = "string"
displayName = "string"
versionHeaderName = "string"
versioningScheme = "string"
versionQueryName = "string"
}
})
}
Property values
service/apiVersionSets
| Name | Description | Value |
|---|---|---|
| type | The resource type | "Microsoft.ApiManagement/service/apiVersionSets@2023-09-01-preview" |
| name | The resource name | string (required) |
| parent_id | The ID of the resource that is the parent for this resource. | ID 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) Constraints: Min length = 1 Max length = 100 |
| versionHeaderName | Name of HTTP header parameter that indicates the API Version if versioningScheme is set to header. |
string Constraints: Min length = 1 Max length = 100 |
| 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 Constraints: Min length = 1 Max length = 100 |