azurermApiManagementNamedValue
Manages an API Management Named Value.
Example Usage
/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as azurerm from "./.gen/providers/azurerm";
/*The following providers are missing schema information and might need manual adjustments to synthesize correctly: azurerm.
For a more precise conversion please use the --provider flag in convert.*/
const azurermResourceGroupExample = new azurerm.resourceGroup.ResourceGroup(
this,
"example",
{
location: "West Europe",
name: "example-resources",
}
);
const azurermApiManagementExample = new azurerm.apiManagement.ApiManagement(
this,
"example_1",
{
location: azurermResourceGroupExample.location,
name: "example-apim",
publisher_email: "pub1@email.com",
publisher_name: "pub1",
resource_group_name: azurermResourceGroupExample.name,
sku_name: "Developer_1",
}
);
/*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/
azurermApiManagementExample.overrideLogicalId("example");
const azurermApiManagementNamedValueExample =
new azurerm.apiManagementNamedValue.ApiManagementNamedValue(
this,
"example_2",
{
api_management_name: azurermApiManagementExample.name,
display_name: "ExampleProperty",
name: "example-apimg",
resource_group_name: azurermResourceGroupExample.name,
value: "Example Value",
}
);
/*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/
azurermApiManagementNamedValueExample.overrideLogicalId("example");
Argument Reference
The following arguments are supported:
-
name- (Required) The name of the API Management Named Value. Changing this forces a new resource to be created. -
resourceGroupName- (Required) The name of the Resource Group in which the API Management Named Value should exist. Changing this forces a new resource to be created. -
apiManagementName- (Required) The name of the API Management Service in which the API Management Named Value should exist. Changing this forces a new resource to be created. -
displayName- (Required) The display name of this API Management Named Value. -
value- (Optional) The value of this API Management Named Value. -
valueFromKeyVault- (Optional) AvalueFromKeyVaultblock as defined below. -
secret- (Optional) Specifies whether the API Management Named Value is secret. Valid values aretrueorfalse. The default value isfalse.
\~> NOTE: setting the field secret to true doesn't make this field sensitive in Terraform, instead it marks the value as secret and encrypts the value in Azure.
tags- (Optional) A list of tags to be applied to the API Management Named Value.
A valueFromKeyVault block supports the following:
-
secretId- (Required) The resource ID of the Key Vault Secret. -
identityClientId- (Optional) The client ID of User Assigned Identity, for the API Management Service, which will be used to access the key vault secret. The System Assigned Identity will be used in absence.
Attributes Reference
In addition to all arguments above, the following attributes are exported:
id- The ID of the API Management Named Value.
Timeouts
The timeouts block allows you to specify timeouts for certain actions:
create- (Defaults to 30 minutes) Used when creating the API Management Named Value.update- (Defaults to 30 minutes) Used when updating the API Management Named Value.read- (Defaults to 5 minutes) Used when retrieving the API Management Named Value.delete- (Defaults to 30 minutes) Used when deleting the API Management Named Value.
Import
API Management Properties can be imported using the resourceId, e.g.