Data Source: azurermApiManagementGroup
Use this data source to access information about an existing API Management Group.
Example Usage
import * as cdktf from "cdktf";
/*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 dataAzurermApiManagementGroupExample =
new azurerm.dataAzurermApiManagementGroup.DataAzurermApiManagementGroup(
this,
"example",
{
api_management_name: "example-apim",
name: "my-group",
resource_group_name: "search-service",
}
);
new cdktf.TerraformOutput(this, "group_type", {
value: dataAzurermApiManagementGroupExample.type,
});
Argument Reference
-
apiManagementName
- The Name of the API Management Service in which this Group exists. -
name
- The Name of the API Management Group. -
resourceGroupName
- The Name of the Resource Group in which the API Management Service exists.
Attributes Reference
-
id
- The ID of the API Management Group. -
displayName
- The display name of this API Management Group. -
description
- The description of this API Management Group. -
externalId
- The identifier of the external Group. -
type
- The type of this API Management Group, such ascustom
orexternal
.
Timeouts
The timeouts
block allows you to specify timeouts for certain actions:
read
- (Defaults to 5 minutes) Used when retrieving the API Management Group.