Service

Manages a Search Service.

Example Usage

using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
    public MyStack()
    {
        var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new Azure.Core.ResourceGroupArgs
        {
            Location = "West Europe",
        });
        var exampleService = new Azure.Search.Service("exampleService", new Azure.Search.ServiceArgs
        {
            ResourceGroupName = exampleResourceGroup.Name,
            Location = exampleResourceGroup.Location,
            Sku = "standard",
        });
    }

}

package main

import (
    "github.com/pulumi/pulumi-azure/sdk/v3/go/azure/core"
    "github.com/pulumi/pulumi-azure/sdk/v3/go/azure/search"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
            Location: pulumi.String("West Europe"),
        })
        if err != nil {
            return err
        }
        _, err = search.NewService(ctx, "exampleService", &search.ServiceArgs{
            ResourceGroupName: exampleResourceGroup.Name,
            Location:          exampleResourceGroup.Location,
            Sku:               pulumi.String("standard"),
        })
        if err != nil {
            return err
        }
        return nil
    })
}

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

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",
});

Create a Service Resource

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

def 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);

func NewService(ctx *Context, name string, args ServiceArgs, opts ...ResourceOption) (*Service, error)

public Service(string name, ServiceArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args ServiceArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args ServiceArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ServiceArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

Service Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The Service resource accepts the following input properties:

ResourceGroupName string: The name of the Resource Group where the Search Service should exist. Changing this forces a new Search Service to be created.
Sku 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.
Location string: The Azure Region where the Search Service should exist. Changing this forces a new Search Service to be created.
Name string: The Name which should be used for this Search Service. Changing this forces a new Search Service to be created.
PartitionCount int: The number of partitions which should be created.
ReplicaCount int: The number of replica’s which should be created.
Tags Dictionary<string, string>: A mapping of tags which should be assigned to the Search Service.

ResourceGroupName string: The name of the Resource Group where the Search Service should exist. Changing this forces a new Search Service to be created.
Sku 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.
Location string: The Azure Region where the Search Service should exist. Changing this forces a new Search Service to be created.
Name string: The Name which should be used for this Search Service. Changing this forces a new Search Service to be created.
PartitionCount int: The number of partitions which should be created.
ReplicaCount int: The number of replica’s which should be created.
Tags map[string]string: A mapping of tags which should be assigned to the Search Service.

resourceGroupName string: The name of the Resource Group where the Search Service should exist. Changing this forces a new Search Service to be created.
sku 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.
location string: The Azure Region where the Search Service should exist. Changing this forces a new Search Service to be created.
name string: The Name which should be used for this Search Service. Changing this forces a new Search Service to be created.
partitionCount number: The number of partitions which should be created.
replicaCount number: The number of replica’s which should be created.
tags {[key: string]: string}: A mapping of tags which should be assigned to the Search Service.

resource_group_name str: The name of the Resource Group where the Search Service should exist. Changing this forces a new Search Service to be created.
sku str: 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.
location str: The Azure Region where the Search Service should exist. Changing this forces a new Search Service to be created.
name str: The Name which should be used for this Search Service. Changing this forces a new Search Service to be created.
partition_count float: The number of partitions which should be created.
replica_count float: The number of replica’s which should be created.
tags Dict[str, str]: A mapping of tags which should be assigned to the Search Service.

Outputs

All input properties are implicitly available as output properties. Additionally, the Service resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.
PrimaryKey string: The Primary Key used for Search Service Administration.
QueryKeys List<ServiceQueryKey>: A query_keys block as defined below.
SecondaryKey string: The Secondary Key used for Search Service Administration.

Id string: The provider-assigned unique ID for this managed resource.
PrimaryKey string: The Primary Key used for Search Service Administration.
QueryKeys []ServiceQueryKey: A query_keys block as defined below.
SecondaryKey string: The Secondary Key used for Search Service Administration.

id string: The provider-assigned unique ID for this managed resource.
primaryKey string: The Primary Key used for Search Service Administration.
queryKeys ServiceQueryKey[]: A query_keys block as defined below.
secondaryKey string: The Secondary Key used for Search Service Administration.

id str: The provider-assigned unique ID for this managed resource.
primary_key str: The Primary Key used for Search Service Administration.
query_keys List[ServiceQueryKey]: A query_keys block as defined below.
secondary_key str: The Secondary Key used for Search Service Administration.

Look up an Existing Service Resource

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

public static get(name: string, id: Input<ID>, state?: ServiceState, opts?: CustomResourceOptions): 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, __props__=None);

func GetService(ctx *Context, name string, id IDInput, state *ServiceState, opts ...ResourceOption) (*Service, error)

public static Service Get(string name, Input<string> id, ServiceState? state, CustomResourceOptions? opts = null)

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

Location string: The Azure Region where the Search Service should exist. Changing this forces a new Search Service to be created.
Name string: The Name which should be used for this Search Service. Changing this forces a new Search Service to be created.
PartitionCount int: The number of partitions which should be created.
PrimaryKey string: The Primary Key used for Search Service Administration.
QueryKeys List<ServiceQueryKeyArgs>: A query_keys block as defined below.
ReplicaCount int: The number of replica’s which should be created.
ResourceGroupName string: The name of the Resource Group where the Search Service should exist. Changing this forces a new Search Service to be created.
SecondaryKey string: The Secondary Key used for Search Service Administration.
Sku 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.
Tags Dictionary<string, string>: A mapping of tags which should be assigned to the Search Service.

Location string: The Azure Region where the Search Service should exist. Changing this forces a new Search Service to be created.
Name string: The Name which should be used for this Search Service. Changing this forces a new Search Service to be created.
PartitionCount int: The number of partitions which should be created.
PrimaryKey string: The Primary Key used for Search Service Administration.
QueryKeys []ServiceQueryKey: A query_keys block as defined below.
ReplicaCount int: The number of replica’s which should be created.
ResourceGroupName string: The name of the Resource Group where the Search Service should exist. Changing this forces a new Search Service to be created.
SecondaryKey string: The Secondary Key used for Search Service Administration.
Sku 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.
Tags map[string]string: A mapping of tags which should be assigned to the Search Service.

location string: The Azure Region where the Search Service should exist. Changing this forces a new Search Service to be created.
name string: The Name which should be used for this Search Service. Changing this forces a new Search Service to be created.
partitionCount number: The number of partitions which should be created.
primaryKey string: The Primary Key used for Search Service Administration.
queryKeys ServiceQueryKey[]: A query_keys block as defined below.
replicaCount number: The number of replica’s which should be created.
resourceGroupName string: The name of the Resource Group where the Search Service should exist. Changing this forces a new Search Service to be created.
secondaryKey string: The Secondary Key used for Search Service Administration.
sku 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.
tags {[key: string]: string}: A mapping of tags which should be assigned to the Search Service.

location str: The Azure Region where the Search Service should exist. Changing this forces a new Search Service to be created.
name str: The Name which should be used for this Search Service. Changing this forces a new Search Service to be created.
partition_count float: The number of partitions which should be created.
primary_key str: The Primary Key used for Search Service Administration.
query_keys List[ServiceQueryKey]: A query_keys block as defined below.
replica_count float: The number of replica’s which should be created.
resource_group_name 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 str: The Secondary Key used for Search Service Administration.
sku str: 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.
tags Dict[str, str]: A mapping of tags which should be assigned to the Search Service.

Supporting Types

ServiceQueryKey

See the output API doc for this type.

Key string: The value of this Query Key.
Name string: The Name which should be used for this Search Service. Changing this forces a new Search Service to be created.

Key string: The value of this Query Key.
Name string: The Name which should be used for this Search Service. Changing this forces a new Search Service to be created.

key string: The value of this Query Key.
name string: The Name which should be used for this Search Service. Changing this forces a new Search Service to be created.

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.

Package Details

Repository: https://github.com/pulumi/pulumi-azure
License: Apache-2.0
Notes: This Pulumi package is based on the azurerm Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud