» azurerm_api_management_property

Manages an API Management Property.

» Example Usage

resource "azurerm_resource_group" "example" {
  name     = "example-resources"
  location = "West US"
}

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_property" "example" {
  name                = "example-apimg"
  resource_group_name = azurerm_resource_group.example.name
  api_management_name = azurerm_api_management.example.name
  display_name        = "ExampleProperty"
  value               = "Example Value"
}

» Argument Reference

The following arguments are supported:

  • name - (Required) The name of the API Management Property. Changing this forces a new resource to be created.

  • resource_group_name - (Required) The name of the Resource Group in which the API Management Property should exist. Changing this forces a new resource to be created.

  • api_management_name - (Required) The name of the API Management Service in which the API Management Property should exist. Changing this forces a new resource to be created.

  • display_name - (Required) The display name of this API Management Property.

  • value - (Required) The value of this API Management Property.

  • secret - (Optional) Specifies whether the API Management Property is secret. Valid values are true or false. The default value is false.

  • tags - (Optional) A list of tags to be applied to the API Management Property.

» Attributes Reference

In addition to all arguments above, the following attributes are exported:

  • id - The ID of the API Management Property.

» Timeouts

The timeouts block allows you to specify timeouts for certain actions:

  • create - (Defaults to 30 minutes) Used when creating the API Management Property.
  • update - (Defaults to 30 minutes) Used when updating the API Management Property.
  • read - (Defaults to 5 minutes) Used when retrieving the API Management Property.
  • delete - (Defaults to 30 minutes) Used when deleting the API Management Property.

» Import

API Management Properties can be imported using the resource id, e.g.

terraform import azurerm_api_management_property.example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/example-resources/providers/Microsoft.ApiManagement/service/example-apim/namedValues/example-apimp