azurermApiManagementApiRelease
Manages a API Management API Release.
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.*/
new azurerm.provider.AzurermProvider(this, "azurerm", {
features: [{}],
});
const azurermResourceGroupExample = new azurerm.resourceGroup.ResourceGroup(
this,
"example",
{
location: "West Europe",
name: "example-resources",
}
);
const azurermApiManagementExample = new azurerm.apiManagement.ApiManagement(
this,
"example_2",
{
location: azurermResourceGroupExample.location,
name: "example-apim",
publisher_email: "company@terraform.io",
publisher_name: "My Company",
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 azurermApiManagementApiExample =
new azurerm.apiManagementApi.ApiManagementApi(this, "example_3", {
api_management_name: azurermApiManagementExample.name,
display_name: "Example API",
import: [
{
content_format: "swagger-link-json",
content_value: "http://conferenceapi.azurewebsites.net/?format=json",
},
],
name: "example-api",
path: "example",
protocols: ["https"],
resource_group_name: azurermResourceGroupExample.name,
revision: "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.*/
azurermApiManagementApiExample.overrideLogicalId("example");
const azurermApiManagementApiReleaseExample =
new azurerm.apiManagementApiRelease.ApiManagementApiRelease(
this,
"example_4",
{
api_id: azurermApiManagementApiExample.id,
name: "example-Api-Release",
}
);
/*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/
azurermApiManagementApiReleaseExample.overrideLogicalId("example");
Arguments Reference
The following arguments are supported:
-
name- (Required) The name which should be used for this API Management API Release. Changing this forces a new API Management API Release to be created. -
apiId- (Required) The ID of the API Management API. Changing this forces a new API Management API Release to be created.
notes- (Optional) The Release Notes.
Attributes Reference
In addition to the Arguments listed above - the following Attributes are exported:
id- The ID of the API Management API Release.
Timeouts
The timeouts block allows you to specify timeouts for certain actions:
create- (Defaults to 30 minutes) Used when creating the API Management API Release.read- (Defaults to 5 minutes) Used when retrieving the API Management API Release.update- (Defaults to 30 minutes) Used when updating the API Management API Release.delete- (Defaults to 30 minutes) Used when deleting the API Management API Release.
Import
API Management API Releases can be imported using the resourceId, e.g.