azurermSearchSharedPrivateLinkService
Manages the Shared Private Link Service for an Azure Search Service.
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 azurermResourceGroupTest = new azurerm.resourceGroup.ResourceGroup(
this,
"test",
{
location: "east us",
name: "example-resourceGroup",
}
);
const azurermSearchServiceTest = new azurerm.searchService.SearchService(
this,
"test_1",
{
location: azurermResourceGroupTest.location,
name: "example-search",
resource_group_name: azurermResourceGroupTest.name,
sku: "standard",
}
);
/*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/
azurermSearchServiceTest.overrideLogicalId("test");
const azurermStorageAccountTest = new azurerm.storageAccount.StorageAccount(
this,
"test_2",
{
account_replication_type: "LRS",
account_tier: "Standard",
location: azurermResourceGroupTest.location,
name: "xiaxintestsaforsearchspl",
resource_group_name: azurermResourceGroupTest.name,
}
);
/*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/
azurermStorageAccountTest.overrideLogicalId("test");
const azurermSearchSharedPrivateLinkServiceTest =
new azurerm.searchSharedPrivateLinkService.SearchSharedPrivateLinkService(
this,
"test_3",
{
name: "example-spl",
request_message: "please approve",
search_service_id: azurermSearchServiceTest.id,
subresource_name: "blob",
target_resource_id: azurermStorageAccountTest.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.*/
azurermSearchSharedPrivateLinkServiceTest.overrideLogicalId("test");
Arguments Reference
The following arguments are supported:
-
name- (Required) Specify the name of the Azure Search Shared Private Link Resource. Changing this forces a new resource to be created. -
searchServiceId- (Required) Specify the id of the Azure Search Service. Changing this forces a new resource to be created. -
subresourceName- (Required) Specify the sub resource name which the Azure Search Private Endpoint is able to connect to. Changing this forces a new resource to be created. -
targetResourceId- (Required) Specify the ID of the Shared Private Link Enabled Remote Resource which this Azure Search Private Endpoint should be connected to. Changing this forces a new resource to be created.
-> NOTE: The sub resource name should match with the type of the target resource id that's being specified.
requestMessage- (Optional) Specify the request message for requesting approval of the Shared Private Link Enabled Remote Resource.
Attributes Reference
The following attributes are exported:
-
id- The ID of the Azure Search Shared Private Link resource. -
status- The status of a private endpoint connection. Possible values are Pending, Approved, Rejected or Disconnected.
Timeouts
The timeouts block allows you to specify timeouts for certain actions:
create- (Defaults to 60 minutes) Used when creating the Azure Search Shared Private Link Resource.read- (Defaults to 5 minutes) Used when retrieving the Azure Search Shared Private Link Resource.update- (Defaults to 60 minutes) Used when updating the Azure Search Shared Private Link Resource.delete- (Defaults to 60 minutes) Used when deleting the Azure Search Shared Private Link Resource.
Import
Azure Search Shared Private Link Resource can be imported using the resourceId, e.g.