1. Docs
  2. Reference
  3. API
  4. @pulumi/azure
  5. search

Module search

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.

Resources

Others

Resources

Resource Service

class Service extends CustomResource

Manages a Search Service.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleService = new azure.search.Service("exampleService", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
    sku: "standard",
});

constructor

new Service(name: string, args: ServiceArgs, opts?: pulumi.CustomResourceOptions)

Create a Service resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ServiceState, opts?: pulumi.CustomResourceOptions): Service

Get an existing Service resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Service

Returns true if the given object is an instance of Service. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property location

public location: pulumi.Output<string>;

The Azure Region where the Search Service should exist. Changing this forces a new Search Service to be created.

property name

public name: pulumi.Output<string>;

The Name which should be used for this Search Service. Changing this forces a new Search Service to be created.

property partitionCount

public partitionCount: pulumi.Output<number>;

The number of partitions which should be created.

property primaryKey

public primaryKey: pulumi.Output<string>;

The Primary Key used for Search Service Administration.

property queryKeys

public queryKeys: pulumi.Output<ServiceQueryKey[]>;

A queryKeys block as defined below.

property replicaCount

public replicaCount: pulumi.Output<number>;

The number of replica’s which should be created.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

The name of the Resource Group where the Search Service should exist. Changing this forces a new Search Service to be created.

property secondaryKey

public secondaryKey: pulumi.Output<string>;

The Secondary Key used for Search Service Administration.

property sku

public sku: pulumi.Output<string>;

The SKU which should be used for this Search Service. Possible values are basic, free, standard, standard2 and standard3 Changing this forces a new Search Service to be created.

property tags

public tags: pulumi.Output<{[key: string]: string} | undefined>;

A mapping of tags which should be assigned to the Search Service.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Others

interface ServiceArgs

interface ServiceArgs

The set of arguments for constructing a Service resource.

property location

location?: pulumi.Input<string>;

The Azure Region where the Search Service should exist. Changing this forces a new Search Service to be created.

property name

name?: pulumi.Input<string>;

The Name which should be used for this Search Service. Changing this forces a new Search Service to be created.

property partitionCount

partitionCount?: pulumi.Input<number>;

The number of partitions which should be created.

property replicaCount

replicaCount?: pulumi.Input<number>;

The number of replica’s which should be created.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

The name of the Resource Group where the Search Service should exist. Changing this forces a new Search Service to be created.

property sku

sku: pulumi.Input<string>;

The SKU which should be used for this Search Service. Possible values are basic, free, standard, standard2 and standard3 Changing this forces a new Search Service to be created.

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags which should be assigned to the Search Service.

interface ServiceState

interface ServiceState

Input properties used for looking up and filtering Service resources.

property location

location?: pulumi.Input<string>;

The Azure Region where the Search Service should exist. Changing this forces a new Search Service to be created.

property name

name?: pulumi.Input<string>;

The Name which should be used for this Search Service. Changing this forces a new Search Service to be created.

property partitionCount

partitionCount?: pulumi.Input<number>;

The number of partitions which should be created.

property primaryKey

primaryKey?: pulumi.Input<string>;

The Primary Key used for Search Service Administration.

property queryKeys

queryKeys?: pulumi.Input<pulumi.Input<ServiceQueryKey>[]>;

A queryKeys block as defined below.

property replicaCount

replicaCount?: pulumi.Input<number>;

The number of replica’s which should be created.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

The name of the Resource Group where the Search Service should exist. Changing this forces a new Search Service to be created.

property secondaryKey

secondaryKey?: pulumi.Input<string>;

The Secondary Key used for Search Service Administration.

property sku

sku?: pulumi.Input<string>;

The SKU which should be used for this Search Service. Possible values are basic, free, standard, standard2 and standard3 Changing this forces a new Search Service to be created.

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags which should be assigned to the Search Service.