Top / Microsoft Azure / Azure API Management / Property

Azure API Management Property

This page shows how to write Terraform and Azure Resource Manager for API Management Property and write them securely.

terraform-logo

Review your .tf file for Azure best practices

Shisho Cloud, our free checker to make sure your Terraform configuration follows best practices, is available (beta).

azurerm_api_management_property (Terraform)

The Property in API Management can be configured in Terraform with the resource name azurerm_api_management_property. The following sections describe 2 examples of how to use the resource and its parameters.

Example Usage from GitHub

main.tf#L7
resource "azurerm_api_management_property" "this" {
  api_management_name = var.api_management_name
  display_name        = var.display_name
  name                = var.name
  resource_group_name = var.resource_group_name
  secret              = var.secret
main.tf#L7
resource "azurerm_api_management_property" "this" {
  api_management_name = var.api_management_name
  display_name        = var.display_name
  name                = var.name
  resource_group_name = var.resource_group_name
  secret              = var.secret

Review your Terraform file for Azure best practices

Shisho Cloud, our free checker to make sure your Terraform configuration follows best practices, is available (beta).

Parameters

>> from Terraform Registry

Explanation in Terraform Registry

Manages an API Management Property.

>> from Terraform Registry

Microsoft.ApiManagement/service/namedValues (Azure Resource Manager)

The service/namedValues in Microsoft.ApiManagement can be configured in Azure Resource Manager with the resource name Microsoft.ApiManagement/service/namedValues. The following sections describe how to use the resource and its parameters.

Example Usage from GitHub

An example could not be found in GitHub.

Parameters

  • apiVersion required - string
  • name required - string

    Identifier of the NamedValue.

  • properties required
      • displayName required - string

        Unique name of NamedValue. It may contain only letters, digits, period, dash, and underscore characters.

      • keyVault optional
          • identityClientId optional - string

            SystemAssignedIdentity or UserAssignedIdentity Client Id which will be used to access key vault secret.

          • secretIdentifier optional - string

            Key vault secret identifier for fetching secret. Providing a versioned secret will prevent auto-refresh. This requires API Management service to be configured with aka.ms/apimmsi

      • secret optional - boolean

        Determines whether the value is a secret and should be encrypted or not. Default value is false.

      • tags optional - array

        Optional tags that when provided can be used to filter the NamedValue list.

      • value optional - string

        Value of the NamedValue. Can contain policy expressions. It may not be empty or consist only of whitespace. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.

  • type required - string

>> from Azure Resource Manager Documentation

The Other Related Azure API Management Resources

Frequently asked questions

What is Azure API Management Property?

Azure API Management Property is a resource for API Management of Microsoft Azure. Settings can be wrote in Terraform.

Where can I find the example code for the Azure API Management Property?

For Terraform, the kevinhead/azurerm and niveklabs/azurerm source code examples are useful. See the Terraform Example section for further details.

security-icon

Automate config file reviews on your commits

Fix issues in your infrastructure as code with auto-generated patches.

Table of Contents