Module search

@pulumi/azure > search

Index

search/service.ts

class Service

Allows you to manage an Azure Search Service.

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): 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

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. 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>;

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

property name

public name: pulumi.Output<string>;

The name of the Search Service. Changing this forces a new resource to be created.

property partitionCount

public partitionCount: pulumi.Output<number>;

Default is 1. Valid values include 1, 2, 3, 4, 6, or 12. Valid only when sku is standard. Changing this forces a new resource to be created.

property primaryKey

public primaryKey: pulumi.Output<string>;

The Search Service Administration primary key.

property replicaCount

public replicaCount: pulumi.Output<number>;

Default is 1. Valid values include 1 through 12. Valid only when sku is standard. Changing this forces a new resource to be created.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

The name of the resource group in which to create the Search Service. Changing this forces a new resource to be created.

property secondaryKey

public secondaryKey: pulumi.Output<string>;

The Search Service Administration secondary key.

property sku

public sku: pulumi.Output<string>;

Valid values are free and standard. standard2 and standard3 are also valid, but can only be used when it’s enabled on the backend by Microsoft support. free provisions the service in shared clusters. standard provisions the service in dedicated clusters. Changing this forces a new resource to be created.

property tags

public tags: pulumi.Output<{ ... }>;

A mapping of tags to assign to the resource. Changing this forces a new resource to be created.

property urn

urn: Output<URN>;

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

interface ServiceArgs

The set of arguments for constructing a Service resource.

property location

location: pulumi.Input<string>;

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

property name

name?: pulumi.Input<string>;

The name of the Search Service. Changing this forces a new resource to be created.

property partitionCount

partitionCount?: pulumi.Input<number>;

Default is 1. Valid values include 1, 2, 3, 4, 6, or 12. Valid only when sku is standard. Changing this forces a new resource to be created.

property replicaCount

replicaCount?: pulumi.Input<number>;

Default is 1. Valid values include 1 through 12. Valid only when sku is standard. Changing this forces a new resource to be created.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

The name of the resource group in which to create the Search Service. Changing this forces a new resource to be created.

property sku

sku: pulumi.Input<string>;

Valid values are free and standard. standard2 and standard3 are also valid, but can only be used when it’s enabled on the backend by Microsoft support. free provisions the service in shared clusters. standard provisions the service in dedicated clusters. Changing this forces a new resource to be created.

property tags

tags?: pulumi.Input<{ ... }>;

A mapping of tags to assign to the resource. Changing this forces a new resource to be created.

interface ServiceState

Input properties used for looking up and filtering Service resources.

property location

location?: pulumi.Input<string>;

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

property name

name?: pulumi.Input<string>;

The name of the Search Service. Changing this forces a new resource to be created.

property partitionCount

partitionCount?: pulumi.Input<number>;

Default is 1. Valid values include 1, 2, 3, 4, 6, or 12. Valid only when sku is standard. Changing this forces a new resource to be created.

property primaryKey

primaryKey?: pulumi.Input<string>;

The Search Service Administration primary key.

property replicaCount

replicaCount?: pulumi.Input<number>;

Default is 1. Valid values include 1 through 12. Valid only when sku is standard. Changing this forces a new resource to be created.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

The name of the resource group in which to create the Search Service. Changing this forces a new resource to be created.

property secondaryKey

secondaryKey?: pulumi.Input<string>;

The Search Service Administration secondary key.

property sku

sku?: pulumi.Input<string>;

Valid values are free and standard. standard2 and standard3 are also valid, but can only be used when it’s enabled on the backend by Microsoft support. free provisions the service in shared clusters. standard provisions the service in dedicated clusters. Changing this forces a new resource to be created.

property tags

tags?: pulumi.Input<{ ... }>;

A mapping of tags to assign to the resource. Changing this forces a new resource to be created.