Manages an API Version Set within an API Management Service.
provider "azurerm" {
features {}
}
resource "azurerm_resource_group" "example" {
name = "example-resources"
location = "West Europe"
}
resource "azurerm_api_management" "example" {
name = "example-apim"
location = azurerm_resource_group.example.location
resource_group_name = azurerm_resource_group.example.name
publisher_name = "pub1"
publisher_email = "pub1@email.com"
sku_name = "Developer_1"
}
resource "azurerm_api_management_api_version_set" "example" {
name = "example-apimapi-1_0_0"
resource_group_name = azurerm_resource_group.example.name
api_management_name = azurerm_api_management.example.name
display_name = "ExampleAPIVersionSet"
versioning_scheme = "Segment"
}
The following arguments are supported:
name
- (Required) The name of the API Version Set. May only contain alphanumeric characters and dashes up to 80 characters in length. Changing this forces a new resource to be created.
api_management_name
- (Required) The name of the API Management Service in which the API Version Set should exist. May only contain alphanumeric characters and dashes up to 50 characters in length. Changing this forces a new resource to be created.
resource_group_name
- (Required) The name of the Resource Group in which the parent API Management Service exists. Changing this forces a new resource to be created.
display_name
- (Required) The display name of this API Version Set.
versioning_scheme
- (Required) Specifies where in an Inbound HTTP Request that the API Version should be read from. Possible values are Header
, Query
and Segment
.
description
- (Optional) The description of API Version Set.
version_header_name
- (Optional) The name of the Header which should be read from Inbound Requests which defines the API Version.
version_query_name
- (Optional) The name of the Query String which should be read from Inbound Requests which defines the API Version.In addition to the Arguments listed above - the following Attributes are exported:
id
- The ID of the API Version Set.The timeouts
block allows you to specify timeouts for certain actions:
create
- (Defaults to 30 minutes) Used when creating the API Management API Version Set.update
- (Defaults to 30 minutes) Used when updating the API Management API Version Set.read
- (Defaults to 5 minutes) Used when retrieving the API Management API Version Set.delete
- (Defaults to 30 minutes) Used when deleting the API Management API Version Set.API Version Set can be imported using the resource id
, e.g.
terraform import azurerm_api_management_api_version_set.example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.ApiManagement/service/service1/apiVersionSets/set1