Skip to content

azurermApiManagementProductGroup

Manages an API Management Product Assignment to a Group.

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 dataAzurermApiManagementExample =
  new azurerm.dataAzurermApiManagement.DataAzurermApiManagement(
    this,
    "example",
    {
      name: "example-api",
      resource_group_name: "example-resources",
    }
  );
const dataAzurermApiManagementGroupExample =
  new azurerm.dataAzurermApiManagementGroup.DataAzurermApiManagementGroup(
    this,
    "example_1",
    {
      api_management_name: dataAzurermApiManagementExample.name,
      name: "my-group",
      resource_group_name: dataAzurermApiManagementExample.resourceGroupName,
    }
  );
/*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/
dataAzurermApiManagementGroupExample.overrideLogicalId("example");
const dataAzurermApiManagementProductExample =
  new azurerm.dataAzurermApiManagementProduct.DataAzurermApiManagementProduct(
    this,
    "example_2",
    {
      api_management_name: dataAzurermApiManagementExample.name,
      product_id: "my-product",
      resource_group_name: dataAzurermApiManagementExample.resourceGroupName,
    }
  );
/*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/
dataAzurermApiManagementProductExample.overrideLogicalId("example");
const azurermApiManagementProductGroupExample =
  new azurerm.apiManagementProductGroup.ApiManagementProductGroup(
    this,
    "example_3",
    {
      api_management_name: dataAzurermApiManagementExample.name,
      group_name: dataAzurermApiManagementGroupExample.name,
      product_id: dataAzurermApiManagementProductExample.productId,
      resource_group_name: dataAzurermApiManagementExample.resourceGroupName,
    }
  );
/*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/
azurermApiManagementProductGroupExample.overrideLogicalId("example");

Argument Reference

The following arguments are supported:

  • productId - (Required) The ID of the API Management Product within the API Management Service. Changing this forces a new resource to be created.

  • groupName - (Required) The Name of the API Management Group within the API Management Service. Changing this forces a new resource to be created.

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

  • resourceGroupName - (Required) The name of the Resource Group in which the API Management Service exists. Changing this forces a new resource to be created.

Attributes Reference

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

  • id - The ID of the API Management Product Group.

Timeouts

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

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

Import

API Management Product Groups can be imported using the resourceId, e.g.

terraform import azurerm_api_management_product_group.example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.ApiManagement/service/service1/products/exampleId/groups/groupId