Skip to content

azurermSearchService

Manages a 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 azurermResourceGroupExample = new azurerm.resourceGroup.ResourceGroup(
  this,
  "example",
  {
    location: "West Europe",
    name: "example-resources",
  }
);
const dataAzurermSearchServiceExample =
  new azurerm.dataAzurermSearchService.DataAzurermSearchService(
    this,
    "example_1",
    {
      name: "example-search-service",
      resource_group_name: azurermResourceGroupExample.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.*/
dataAzurermSearchServiceExample.overrideLogicalId("example");

Arguments Reference

The following arguments are supported:

  • name - (Required) The Name of the Search Service.

  • resourceGroupName - (Required) The name of the Resource Group where the Search Service exists.

Attributes Reference

In addition to the Arguments listed above - the following Attributes are exported:

  • id - The ID of the Search Service.

  • primaryKey - The Primary Key used for Search Service Administration.

  • secondaryKey - The Secondary Key used for Search Service Administration.

  • queryKeys - A queryKeys block as defined below.

  • publicNetworkAccessEnabled - Whether or not public network access is enabled for this resource.

  • partitionCount - The number of partitions which have been created.

  • replicaCount - The number of replica's which have been created.

  • identity - An identity block as defined below.

An identity block exports the following:

  • principalId - The Principal ID associated with this Managed Service Identity.

  • tenantId - The Tenant ID associated with this Managed Service Identity.

  • type - The identity type of this Managed Service Identity.

A queryKeys block exports the following:

  • key - The value of this Query Key.

  • name - The name of this Query Key.

A identity block exports the following:

  • principalId - The (Client) ID of the Service Principal.

  • tenantId - The ID of the Tenant the Service Principal is assigned in.

Timeouts

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

  • read - (Defaults to 5 minutes) Used when retrieving the Search Service.