Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Bicep resource definition
The service/workspaces/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/workspaces/apiVersionSets resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.ApiManagement/service/workspaces/apiVersionSets@2023-09-01-preview' = {
parent: resourceSymbolicName
name: 'string'
properties: {
description: 'string'
displayName: 'string'
versionHeaderName: 'string'
versioningScheme: 'string'
versionQueryName: 'string'
}
}
Property Values
ApiVersionSetContractProperties
| Name | Description | Value |
|---|---|---|
| description | Description of API Version Set. | string |
| displayName | Name of API Version Set | string Constraints: Min length = 1 Max length = 100 (required) |
| 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 |
Microsoft.ApiManagement/service/workspaces/apiVersionSets
| Name | Description | Value |
|---|---|---|
| name | The resource name | string Constraints: Min length = 1 Max length = 80 Pattern = ^[^*#&+:<>?]+$ (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/workspaces |
| properties | API VersionSet contract properties. | ApiVersionSetContractProperties |
ARM template resource definition
The service/workspaces/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/workspaces/apiVersionSets resource, add the following JSON to your template.
{
"type": "Microsoft.ApiManagement/service/workspaces/apiVersionSets",
"apiVersion": "2023-09-01-preview",
"name": "string",
"properties": {
"description": "string",
"displayName": "string",
"versionHeaderName": "string",
"versioningScheme": "string",
"versionQueryName": "string"
}
}
Property Values
ApiVersionSetContractProperties
| Name | Description | Value |
|---|---|---|
| description | Description of API Version Set. | string |
| displayName | Name of API Version Set | string Constraints: Min length = 1 Max length = 100 (required) |
| 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 |
Microsoft.ApiManagement/service/workspaces/apiVersionSets
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2023-09-01-preview' |
| name | The resource name | string Constraints: Min length = 1 Max length = 80 Pattern = ^[^*#&+:<>?]+$ (required) |
| properties | API VersionSet contract properties. | ApiVersionSetContractProperties |
| type | The resource type | 'Microsoft.ApiManagement/service/workspaces/apiVersionSets' |
Usage Examples
Terraform (AzAPI provider) resource definition
The service/workspaces/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/workspaces/apiVersionSets resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/workspaces/apiVersionSets@2023-09-01-preview"
name = "string"
body = {
properties = {
description = "string"
displayName = "string"
versionHeaderName = "string"
versioningScheme = "string"
versionQueryName = "string"
}
}
}
Property Values
ApiVersionSetContractProperties
| Name | Description | Value |
|---|---|---|
| description | Description of API Version Set. | string |
| displayName | Name of API Version Set | string Constraints: Min length = 1 Max length = 100 (required) |
| 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 |
Microsoft.ApiManagement/service/workspaces/apiVersionSets
| Name | Description | Value |
|---|---|---|
| name | The resource name | string Constraints: Min length = 1 Max length = 80 Pattern = ^[^*#&+:<>?]+$ (required) |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: service/workspaces |
| properties | API VersionSet contract properties. | ApiVersionSetContractProperties |
| type | The resource type | "Microsoft.ApiManagement/service/workspaces/apiVersionSets@2023-09-01-preview" |