azurermApiManagementGroupUser
Manages an API Management User 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 dataAzurermApiManagementUserExample =
new azurerm.dataAzurermApiManagementUser.DataAzurermApiManagementUser(
this,
"example",
{
api_management_name: "example-apim",
resource_group_name: "search-service",
user_id: "my-user",
}
);
const azurermApiManagementGroupUserExample =
new azurerm.apiManagementGroupUser.ApiManagementGroupUser(this, "example_1", {
api_management_name: dataAzurermApiManagementUserExample.apiManagementName,
group_name: "example-group",
resource_group_name: dataAzurermApiManagementUserExample.resourceGroupName,
user_id: dataAzurermApiManagementUserExample.id,
});
/*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/
azurermApiManagementGroupUserExample.overrideLogicalId("example");
Argument Reference
The following arguments are supported:
-
userId- (Required) The ID of the API Management User which should be assigned to this API Management Group. 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 Group User.
Timeouts
The timeouts block allows you to specify timeouts for certain actions:
create- (Defaults to 30 minutes) Used when creating the API Management Group User.update- (Defaults to 30 minutes) Used when updating the API Management Group User.read- (Defaults to 5 minutes) Used when retrieving the API Management Group User.delete- (Defaults to 30 minutes) Used when deleting the API Management Group User.
Import
API Management Group Users can be imported using the resourceId, e.g.