This page documents the language specification for the azure package. If you're looking for help working with the inputs, outputs, or functions of azure resources in a Pulumi program, please see the resource documentation for examples and API reference.
search¶
This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-azure repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-azurerm repo.
- class
pulumi_azure.search.Service(resource_name, opts=None, location=None, name=None, partition_count=None, replica_count=None, resource_group_name=None, sku=None, tags=None, __props__=None, __name__=None, __opts__=None)¶ Manages a Search Service.
import pulumi import pulumi_azure as azure example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe") example_service = azure.search.Service("exampleService", resource_group_name=example_resource_group.name, location=example_resource_group.location, sku="standard")
- Parameters
resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
location (pulumi.Input[str]) – The Azure Region where the Search Service should exist. Changing this forces a new Search Service to be created.
name (pulumi.Input[str]) – The Name which should be used for this Search Service. Changing this forces a new Search Service to be created.
partition_count (pulumi.Input[float]) – The number of partitions which should be created.
replica_count (pulumi.Input[float]) – The number of replica’s which should be created.
resource_group_name (pulumi.Input[str]) – The name of the Resource Group where the Search Service should exist. Changing this forces a new Search Service to be created.
sku (pulumi.Input[str]) – The SKU which should be used for this Search Service. Possible values are
basic,free,standard,standard2andstandard3Changing this forces a new Search Service to be created.tags (pulumi.Input[dict]) – A mapping of tags which should be assigned to the Search Service.
location: pulumi.Output[str] = None¶The Azure Region where the Search Service should exist. Changing this forces a new Search Service to be created.
name: pulumi.Output[str] = None¶The Name which should be used for this Search Service. Changing this forces a new Search Service to be created.
partition_count: pulumi.Output[float] = None¶The number of partitions which should be created.
primary_key: pulumi.Output[str] = None¶The Primary Key used for Search Service Administration.
query_keys: pulumi.Output[list] = None¶A
query_keysblock as defined below.key(str) - The value of this Query Key.name(str) - The Name which should be used for this Search Service. Changing this forces a new Search Service to be created.
replica_count: pulumi.Output[float] = None¶The number of replica’s which should be created.
resource_group_name: pulumi.Output[str] = None¶The name of the Resource Group where the Search Service should exist. Changing this forces a new Search Service to be created.
secondary_key: pulumi.Output[str] = None¶The Secondary Key used for Search Service Administration.
sku: pulumi.Output[str] = None¶The SKU which should be used for this Search Service. Possible values are
basic,free,standard,standard2andstandard3Changing this forces a new Search Service to be created.
A mapping of tags which should be assigned to the Search Service.
- static
get(resource_name, id, opts=None, location=None, name=None, partition_count=None, primary_key=None, query_keys=None, replica_count=None, resource_group_name=None, secondary_key=None, sku=None, tags=None)¶ Get an existing Service resource’s state with the given name, id, and optional extra properties used to qualify the lookup.
- Parameters
resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
location (pulumi.Input[str]) – The Azure Region where the Search Service should exist. Changing this forces a new Search Service to be created.
name (pulumi.Input[str]) – The Name which should be used for this Search Service. Changing this forces a new Search Service to be created.
partition_count (pulumi.Input[float]) – The number of partitions which should be created.
primary_key (pulumi.Input[str]) – The Primary Key used for Search Service Administration.
query_keys (pulumi.Input[list]) – A
query_keysblock as defined below.replica_count (pulumi.Input[float]) – The number of replica’s which should be created.
resource_group_name (pulumi.Input[str]) – The name of the Resource Group where the Search Service should exist. Changing this forces a new Search Service to be created.
secondary_key (pulumi.Input[str]) – The Secondary Key used for Search Service Administration.
sku (pulumi.Input[str]) – The SKU which should be used for this Search Service. Possible values are
basic,free,standard,standard2andstandard3Changing this forces a new Search Service to be created.tags (pulumi.Input[dict]) – A mapping of tags which should be assigned to the Search Service.
The query_keys object supports the following:
key(pulumi.Input[str]) - The value of this Query Key.name(pulumi.Input[str]) - The Name which should be used for this Search Service. Changing this forces a new Search Service to be created.
translate_output_property(prop)¶Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.
- Parameters
prop (str) – A property name.
- Returns
A potentially transformed property name.
- Return type
str
translate_input_property(prop)¶Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.
- Parameters
prop (str) – A property name.
- Returns
A potentially transformed property name.
- Return type
str