Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Classic
  3. API Docs
  4. search
  5. Service

We recommend using Azure Native.

Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-azure

azure.search.Service

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-azure

    Manages a Search Service.

    Example Usage

    Supporting API Keys)

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

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

    import pulumi
import pulumi_azure as azure

example = azure.core.ResourceGroup("example",
    name="example-resources",
    location="West Europe")
example_service = azure.search.Service("example",
    name="example-resource",
    resource_group_name=example.name,
    location=example.location,
    sku="standard")

    package main

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

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

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var example = new Azure.Core.ResourceGroup("example", new()
    {
        Name = "example-resources",
        Location = "West Europe",
    });

    var exampleService = new Azure.Search.Service("example", new()
    {
        Name = "example-resource",
        ResourceGroupName = example.Name,
        Location = example.Location,
        Sku = "standard",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.search.Service;
import com.pulumi.azure.search.ServiceArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new ResourceGroup("example", ResourceGroupArgs.builder()
            .name("example-resources")
            .location("West Europe")
            .build());

        var exampleService = new Service("exampleService", ServiceArgs.builder()
            .name("example-resource")
            .resourceGroupName(example.name())
            .location(example.location())
            .sku("standard")
            .build());

    }
}

    resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example-resources
      location: West Europe
  exampleService:
    type: azure:search:Service
    name: example
    properties:
      name: example-resource
      resourceGroupName: ${example.name}
      location: ${example.location}
      sku: standard

    Using Both AzureAD And API Keys)

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

const example = new azure.core.ResourceGroup("example", {
    name: "example-resources",
    location: "West Europe",
});
const exampleService = new azure.search.Service("example", {
    name: "example-resource",
    resourceGroupName: example.name,
    location: example.location,
    sku: "standard",
    localAuthenticationEnabled: true,
    authenticationFailureMode: "http403",
});

    import pulumi
import pulumi_azure as azure

example = azure.core.ResourceGroup("example",
    name="example-resources",
    location="West Europe")
example_service = azure.search.Service("example",
    name="example-resource",
    resource_group_name=example.name,
    location=example.location,
    sku="standard",
    local_authentication_enabled=True,
    authentication_failure_mode="http403")

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
			Name:     pulumi.String("example-resources"),
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		_, err = search.NewService(ctx, "example", &search.ServiceArgs{
			Name:                       pulumi.String("example-resource"),
			ResourceGroupName:          example.Name,
			Location:                   example.Location,
			Sku:                        pulumi.String("standard"),
			LocalAuthenticationEnabled: pulumi.Bool(true),
			AuthenticationFailureMode:  pulumi.String("http403"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var example = new Azure.Core.ResourceGroup("example", new()
    {
        Name = "example-resources",
        Location = "West Europe",
    });

    var exampleService = new Azure.Search.Service("example", new()
    {
        Name = "example-resource",
        ResourceGroupName = example.Name,
        Location = example.Location,
        Sku = "standard",
        LocalAuthenticationEnabled = true,
        AuthenticationFailureMode = "http403",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.search.Service;
import com.pulumi.azure.search.ServiceArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new ResourceGroup("example", ResourceGroupArgs.builder()
            .name("example-resources")
            .location("West Europe")
            .build());

        var exampleService = new Service("exampleService", ServiceArgs.builder()
            .name("example-resource")
            .resourceGroupName(example.name())
            .location(example.location())
            .sku("standard")
            .localAuthenticationEnabled(true)
            .authenticationFailureMode("http403")
            .build());

    }
}

    resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example-resources
      location: West Europe
  exampleService:
    type: azure:search:Service
    name: example
    properties:
      name: example-resource
      resourceGroupName: ${example.name}
      location: ${example.location}
      sku: standard
      localAuthenticationEnabled: true
      authenticationFailureMode: http403

    Supporting Only AzureAD Authentication)

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

const example = new azure.core.ResourceGroup("example", {
    name: "example-resources",
    location: "West Europe",
});
const exampleService = new azure.search.Service("example", {
    name: "example-resource",
    resourceGroupName: example.name,
    location: example.location,
    sku: "standard",
    localAuthenticationEnabled: false,
});

    import pulumi
import pulumi_azure as azure

example = azure.core.ResourceGroup("example",
    name="example-resources",
    location="West Europe")
example_service = azure.search.Service("example",
    name="example-resource",
    resource_group_name=example.name,
    location=example.location,
    sku="standard",
    local_authentication_enabled=False)

    package main

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

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

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var example = new Azure.Core.ResourceGroup("example", new()
    {
        Name = "example-resources",
        Location = "West Europe",
    });

    var exampleService = new Azure.Search.Service("example", new()
    {
        Name = "example-resource",
        ResourceGroupName = example.Name,
        Location = example.Location,
        Sku = "standard",
        LocalAuthenticationEnabled = false,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.search.Service;
import com.pulumi.azure.search.ServiceArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new ResourceGroup("example", ResourceGroupArgs.builder()
            .name("example-resources")
            .location("West Europe")
            .build());

        var exampleService = new Service("exampleService", ServiceArgs.builder()
            .name("example-resource")
            .resourceGroupName(example.name())
            .location(example.location())
            .sku("standard")
            .localAuthenticationEnabled(false)
            .build());

    }
}

    resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example-resources
      location: West Europe
  exampleService:
    type: azure:search:Service
    name: example
    properties:
      name: example-resource
      resourceGroupName: ${example.name}
      location: ${example.location}
      sku: standard
      localAuthenticationEnabled: false

    Create Service Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Service(name: string, args: ServiceArgs, opts?: CustomResourceOptions);
    @overload
def Service(resource_name: str,
            args: ServiceArgs,
            opts: Optional[ResourceOptions] = None)

@overload
def Service(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            resource_group_name: Optional[str] = None,
            sku: Optional[str] = None,
            location: Optional[str] = None,
            hosting_mode: Optional[str] = None,
            identity: Optional[ServiceIdentityArgs] = None,
            local_authentication_enabled: Optional[bool] = None,
            allowed_ips: Optional[Sequence[str]] = None,
            name: Optional[str] = None,
            partition_count: Optional[int] = None,
            public_network_access_enabled: Optional[bool] = None,
            replica_count: Optional[int] = None,
            customer_managed_key_enforcement_enabled: Optional[bool] = None,
            semantic_search_sku: Optional[str] = None,
            authentication_failure_mode: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None)
    func NewService(ctx *Context, name string, args ServiceArgs, opts ...ResourceOption) (*Service, error)
    public Service(string name, ServiceArgs args, CustomResourceOptions? opts = null)
    public Service(String name, ServiceArgs args)
public Service(String name, ServiceArgs args, CustomResourceOptions options)

    type: azure:search:Service
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    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.
    args ServiceArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control 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.
    name String
    The unique name of the resource.
    args ServiceArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var exampleserviceResourceResourceFromSearchservice = new Azure.Search.Service("exampleserviceResourceResourceFromSearchservice", new()
{
    ResourceGroupName = "string",
    Sku = "string",
    Location = "string",
    HostingMode = "string",
    Identity = new Azure.Search.Inputs.ServiceIdentityArgs
    {
        Type = "string",
        PrincipalId = "string",
        TenantId = "string",
    },
    LocalAuthenticationEnabled = false,
    AllowedIps = new[]
    {
        "string",
    },
    Name = "string",
    PartitionCount = 0,
    PublicNetworkAccessEnabled = false,
    ReplicaCount = 0,
    CustomerManagedKeyEnforcementEnabled = false,
    SemanticSearchSku = "string",
    AuthenticationFailureMode = "string",
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := search.NewService(ctx, "exampleserviceResourceResourceFromSearchservice", &search.ServiceArgs{
	ResourceGroupName: pulumi.String("string"),
	Sku:               pulumi.String("string"),
	Location:          pulumi.String("string"),
	HostingMode:       pulumi.String("string"),
	Identity: &search.ServiceIdentityArgs{
		Type:        pulumi.String("string"),
		PrincipalId: pulumi.String("string"),
		TenantId:    pulumi.String("string"),
	},
	LocalAuthenticationEnabled: pulumi.Bool(false),
	AllowedIps: pulumi.StringArray{
		pulumi.String("string"),
	},
	Name:                                 pulumi.String("string"),
	PartitionCount:                       pulumi.Int(0),
	PublicNetworkAccessEnabled:           pulumi.Bool(false),
	ReplicaCount:                         pulumi.Int(0),
	CustomerManagedKeyEnforcementEnabled: pulumi.Bool(false),
	SemanticSearchSku:                    pulumi.String("string"),
	AuthenticationFailureMode:            pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var exampleserviceResourceResourceFromSearchservice = new Service("exampleserviceResourceResourceFromSearchservice", ServiceArgs.builder()
    .resourceGroupName("string")
    .sku("string")
    .location("string")
    .hostingMode("string")
    .identity(ServiceIdentityArgs.builder()
        .type("string")
        .principalId("string")
        .tenantId("string")
        .build())
    .localAuthenticationEnabled(false)
    .allowedIps("string")
    .name("string")
    .partitionCount(0)
    .publicNetworkAccessEnabled(false)
    .replicaCount(0)
    .customerManagedKeyEnforcementEnabled(false)
    .semanticSearchSku("string")
    .authenticationFailureMode("string")
    .tags(Map.of("string", "string"))
    .build());

    exampleservice_resource_resource_from_searchservice = azure.search.Service("exampleserviceResourceResourceFromSearchservice",
    resource_group_name="string",
    sku="string",
    location="string",
    hosting_mode="string",
    identity={
        "type": "string",
        "principal_id": "string",
        "tenant_id": "string",
    },
    local_authentication_enabled=False,
    allowed_ips=["string"],
    name="string",
    partition_count=0,
    public_network_access_enabled=False,
    replica_count=0,
    customer_managed_key_enforcement_enabled=False,
    semantic_search_sku="string",
    authentication_failure_mode="string",
    tags={
        "string": "string",
    })

    const exampleserviceResourceResourceFromSearchservice = new azure.search.Service("exampleserviceResourceResourceFromSearchservice", {
    resourceGroupName: "string",
    sku: "string",
    location: "string",
    hostingMode: "string",
    identity: {
        type: "string",
        principalId: "string",
        tenantId: "string",
    },
    localAuthenticationEnabled: false,
    allowedIps: ["string"],
    name: "string",
    partitionCount: 0,
    publicNetworkAccessEnabled: false,
    replicaCount: 0,
    customerManagedKeyEnforcementEnabled: false,
    semanticSearchSku: "string",
    authenticationFailureMode: "string",
    tags: {
        string: "string",
    },
});

    type: azure:search:Service
properties:
    allowedIps:
        - string
    authenticationFailureMode: string
    customerManagedKeyEnforcementEnabled: false
    hostingMode: string
    identity:
        principalId: string
        tenantId: string
        type: string
    localAuthenticationEnabled: false
    location: string
    name: string
    partitionCount: 0
    publicNetworkAccessEnabled: false
    replicaCount: 0
    resourceGroupName: string
    semanticSearchSku: string
    sku: string
    tags:
        string: string

    Service Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    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 include basic, free, standard, standard2, standard3, storage_optimized_l1 and storage_optimized_l2. Changing this forces a new Search Service to be created.

    The basic and free SKUs provision the Search Service in a Shared Cluster - the standard SKUs use a Dedicated Cluster.

    NOTE: The SKUs standard2, standard3, storage_optimized_l1 and storage_optimized_l2 are only available by submitting a quota increase request to Microsoft. Please see the product documentation on how to submit a quota increase request.

    AllowedIps List<string>

    Specifies a list of inbound IPv4 or CIDRs that are allowed to access the Search Service. If the incoming IP request is from an IP address which is not included in the allowed_ips it will be blocked by the Search Services firewall.

    NOTE: The allowed_ips are only applied if the public_network_access_enabled field has been set to true, else all traffic over the public interface will be rejected, even if the allowed_ips field has been defined. When the public_network_access_enabled field has been set to false the private endpoint connections are the only allowed access point to the Search Service.

    AuthenticationFailureMode string

    Specifies the response that the Search Service should return for requests that fail authentication. Possible values include http401WithBearerChallenge or http403.

    NOTE: authentication_failure_mode can only be configured when using local_authentication_enabled is set to true - which when set together specifies that both API Keys and AzureAD Authentication should be supported.

    CustomerManagedKeyEnforcementEnabled bool
    Specifies whether the Search Service should enforce that non-customer resources are encrypted. Defaults to false.
    HostingMode string

    Specifies the Hosting Mode, which allows for High Density partitions (that allow for up to 1000 indexes) should be supported. Possible values are highDensity or default. Defaults to default. Changing this forces a new Search Service to be created.

    NOTE: hosting_mode can only be configured when sku is set to standard3.

    Identity ServiceIdentity
    An identity block as defined below.
    LocalAuthenticationEnabled bool
    Specifies whether the Search Service allows authenticating using API Keys? Defaults to true.
    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

    Specifies the number of partitions which should be created. This field cannot be set when using a free or basic sku (see the Microsoft documentation). Possible values include 1, 2, 3, 4, 6, or 12. Defaults to 1.

    NOTE: when hosting_mode is set to highDensity the maximum number of partitions allowed is 3.

    PublicNetworkAccessEnabled bool
    Specifies whether Public Network Access is allowed for this resource. Defaults to true.
    ReplicaCount int
    Specifies the number of Replica's which should be created for this Search Service. This field cannot be set when using a free sku (see the Microsoft documentation).
    SemanticSearchSku string

    Specifies the Semantic Search SKU which should be used for this Search Service. Possible values include free and standard.

    NOTE: The semantic_search_sku cannot be defined if your Search Services sku is set to free. The Semantic Search feature is only available in certain regions, please see the product documentation for more information.

    Tags Dictionary<string, string>
    Specifies a mapping of tags which should be assigned to this 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 include basic, free, standard, standard2, standard3, storage_optimized_l1 and storage_optimized_l2. Changing this forces a new Search Service to be created.

    The basic and free SKUs provision the Search Service in a Shared Cluster - the standard SKUs use a Dedicated Cluster.

    NOTE: The SKUs standard2, standard3, storage_optimized_l1 and storage_optimized_l2 are only available by submitting a quota increase request to Microsoft. Please see the product documentation on how to submit a quota increase request.

    AllowedIps []string

    Specifies a list of inbound IPv4 or CIDRs that are allowed to access the Search Service. If the incoming IP request is from an IP address which is not included in the allowed_ips it will be blocked by the Search Services firewall.

    NOTE: The allowed_ips are only applied if the public_network_access_enabled field has been set to true, else all traffic over the public interface will be rejected, even if the allowed_ips field has been defined. When the public_network_access_enabled field has been set to false the private endpoint connections are the only allowed access point to the Search Service.

    AuthenticationFailureMode string

    Specifies the response that the Search Service should return for requests that fail authentication. Possible values include http401WithBearerChallenge or http403.

    NOTE: authentication_failure_mode can only be configured when using local_authentication_enabled is set to true - which when set together specifies that both API Keys and AzureAD Authentication should be supported.

    CustomerManagedKeyEnforcementEnabled bool
    Specifies whether the Search Service should enforce that non-customer resources are encrypted. Defaults to false.
    HostingMode string

    Specifies the Hosting Mode, which allows for High Density partitions (that allow for up to 1000 indexes) should be supported. Possible values are highDensity or default. Defaults to default. Changing this forces a new Search Service to be created.

    NOTE: hosting_mode can only be configured when sku is set to standard3.

    Identity ServiceIdentityArgs
    An identity block as defined below.
    LocalAuthenticationEnabled bool
    Specifies whether the Search Service allows authenticating using API Keys? Defaults to true.
    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

    Specifies the number of partitions which should be created. This field cannot be set when using a free or basic sku (see the Microsoft documentation). Possible values include 1, 2, 3, 4, 6, or 12. Defaults to 1.

    NOTE: when hosting_mode is set to highDensity the maximum number of partitions allowed is 3.

    PublicNetworkAccessEnabled bool
    Specifies whether Public Network Access is allowed for this resource. Defaults to true.
    ReplicaCount int
    Specifies the number of Replica's which should be created for this Search Service. This field cannot be set when using a free sku (see the Microsoft documentation).
    SemanticSearchSku string

    Specifies the Semantic Search SKU which should be used for this Search Service. Possible values include free and standard.

    NOTE: The semantic_search_sku cannot be defined if your Search Services sku is set to free. The Semantic Search feature is only available in certain regions, please see the product documentation for more information.

    Tags map[string]string
    Specifies a mapping of tags which should be assigned to this 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 include basic, free, standard, standard2, standard3, storage_optimized_l1 and storage_optimized_l2. Changing this forces a new Search Service to be created.

    The basic and free SKUs provision the Search Service in a Shared Cluster - the standard SKUs use a Dedicated Cluster.

    NOTE: The SKUs standard2, standard3, storage_optimized_l1 and storage_optimized_l2 are only available by submitting a quota increase request to Microsoft. Please see the product documentation on how to submit a quota increase request.

    allowedIps List<String>

    Specifies a list of inbound IPv4 or CIDRs that are allowed to access the Search Service. If the incoming IP request is from an IP address which is not included in the allowed_ips it will be blocked by the Search Services firewall.

    NOTE: The allowed_ips are only applied if the public_network_access_enabled field has been set to true, else all traffic over the public interface will be rejected, even if the allowed_ips field has been defined. When the public_network_access_enabled field has been set to false the private endpoint connections are the only allowed access point to the Search Service.

    authenticationFailureMode String

    Specifies the response that the Search Service should return for requests that fail authentication. Possible values include http401WithBearerChallenge or http403.

    NOTE: authentication_failure_mode can only be configured when using local_authentication_enabled is set to true - which when set together specifies that both API Keys and AzureAD Authentication should be supported.

    customerManagedKeyEnforcementEnabled Boolean
    Specifies whether the Search Service should enforce that non-customer resources are encrypted. Defaults to false.
    hostingMode String

    Specifies the Hosting Mode, which allows for High Density partitions (that allow for up to 1000 indexes) should be supported. Possible values are highDensity or default. Defaults to default. Changing this forces a new Search Service to be created.

    NOTE: hosting_mode can only be configured when sku is set to standard3.

    identity ServiceIdentity
    An identity block as defined below.
    localAuthenticationEnabled Boolean
    Specifies whether the Search Service allows authenticating using API Keys? Defaults to true.
    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 Integer

    Specifies the number of partitions which should be created. This field cannot be set when using a free or basic sku (see the Microsoft documentation). Possible values include 1, 2, 3, 4, 6, or 12. Defaults to 1.

    NOTE: when hosting_mode is set to highDensity the maximum number of partitions allowed is 3.

    publicNetworkAccessEnabled Boolean
    Specifies whether Public Network Access is allowed for this resource. Defaults to true.
    replicaCount Integer
    Specifies the number of Replica's which should be created for this Search Service. This field cannot be set when using a free sku (see the Microsoft documentation).
    semanticSearchSku String

    Specifies the Semantic Search SKU which should be used for this Search Service. Possible values include free and standard.

    NOTE: The semantic_search_sku cannot be defined if your Search Services sku is set to free. The Semantic Search feature is only available in certain regions, please see the product documentation for more information.

    tags Map<String,String>
    Specifies a mapping of tags which should be assigned to this 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 include basic, free, standard, standard2, standard3, storage_optimized_l1 and storage_optimized_l2. Changing this forces a new Search Service to be created.

    The basic and free SKUs provision the Search Service in a Shared Cluster - the standard SKUs use a Dedicated Cluster.

    NOTE: The SKUs standard2, standard3, storage_optimized_l1 and storage_optimized_l2 are only available by submitting a quota increase request to Microsoft. Please see the product documentation on how to submit a quota increase request.

    allowedIps string[]

    Specifies a list of inbound IPv4 or CIDRs that are allowed to access the Search Service. If the incoming IP request is from an IP address which is not included in the allowed_ips it will be blocked by the Search Services firewall.

    NOTE: The allowed_ips are only applied if the public_network_access_enabled field has been set to true, else all traffic over the public interface will be rejected, even if the allowed_ips field has been defined. When the public_network_access_enabled field has been set to false the private endpoint connections are the only allowed access point to the Search Service.

    authenticationFailureMode string

    Specifies the response that the Search Service should return for requests that fail authentication. Possible values include http401WithBearerChallenge or http403.

    NOTE: authentication_failure_mode can only be configured when using local_authentication_enabled is set to true - which when set together specifies that both API Keys and AzureAD Authentication should be supported.

    customerManagedKeyEnforcementEnabled boolean
    Specifies whether the Search Service should enforce that non-customer resources are encrypted. Defaults to false.
    hostingMode string

    Specifies the Hosting Mode, which allows for High Density partitions (that allow for up to 1000 indexes) should be supported. Possible values are highDensity or default. Defaults to default. Changing this forces a new Search Service to be created.

    NOTE: hosting_mode can only be configured when sku is set to standard3.

    identity ServiceIdentity
    An identity block as defined below.
    localAuthenticationEnabled boolean
    Specifies whether the Search Service allows authenticating using API Keys? Defaults to true.
    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

    Specifies the number of partitions which should be created. This field cannot be set when using a free or basic sku (see the Microsoft documentation). Possible values include 1, 2, 3, 4, 6, or 12. Defaults to 1.

    NOTE: when hosting_mode is set to highDensity the maximum number of partitions allowed is 3.

    publicNetworkAccessEnabled boolean
    Specifies whether Public Network Access is allowed for this resource. Defaults to true.
    replicaCount number
    Specifies the number of Replica's which should be created for this Search Service. This field cannot be set when using a free sku (see the Microsoft documentation).
    semanticSearchSku string

    Specifies the Semantic Search SKU which should be used for this Search Service. Possible values include free and standard.

    NOTE: The semantic_search_sku cannot be defined if your Search Services sku is set to free. The Semantic Search feature is only available in certain regions, please see the product documentation for more information.

    tags {[key: string]: string}
    Specifies a mapping of tags which should be assigned to this 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 include basic, free, standard, standard2, standard3, storage_optimized_l1 and storage_optimized_l2. Changing this forces a new Search Service to be created.

    The basic and free SKUs provision the Search Service in a Shared Cluster - the standard SKUs use a Dedicated Cluster.

    NOTE: The SKUs standard2, standard3, storage_optimized_l1 and storage_optimized_l2 are only available by submitting a quota increase request to Microsoft. Please see the product documentation on how to submit a quota increase request.

    allowed_ips Sequence[str]

    Specifies a list of inbound IPv4 or CIDRs that are allowed to access the Search Service. If the incoming IP request is from an IP address which is not included in the allowed_ips it will be blocked by the Search Services firewall.

    NOTE: The allowed_ips are only applied if the public_network_access_enabled field has been set to true, else all traffic over the public interface will be rejected, even if the allowed_ips field has been defined. When the public_network_access_enabled field has been set to false the private endpoint connections are the only allowed access point to the Search Service.

    authentication_failure_mode str

    Specifies the response that the Search Service should return for requests that fail authentication. Possible values include http401WithBearerChallenge or http403.

    NOTE: authentication_failure_mode can only be configured when using local_authentication_enabled is set to true - which when set together specifies that both API Keys and AzureAD Authentication should be supported.

    customer_managed_key_enforcement_enabled bool
    Specifies whether the Search Service should enforce that non-customer resources are encrypted. Defaults to false.
    hosting_mode str

    Specifies the Hosting Mode, which allows for High Density partitions (that allow for up to 1000 indexes) should be supported. Possible values are highDensity or default. Defaults to default. Changing this forces a new Search Service to be created.

    NOTE: hosting_mode can only be configured when sku is set to standard3.

    identity ServiceIdentityArgs
    An identity block as defined below.
    local_authentication_enabled bool
    Specifies whether the Search Service allows authenticating using API Keys? Defaults to true.
    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 int

    Specifies the number of partitions which should be created. This field cannot be set when using a free or basic sku (see the Microsoft documentation). Possible values include 1, 2, 3, 4, 6, or 12. Defaults to 1.

    NOTE: when hosting_mode is set to highDensity the maximum number of partitions allowed is 3.

    public_network_access_enabled bool
    Specifies whether Public Network Access is allowed for this resource. Defaults to true.
    replica_count int
    Specifies the number of Replica's which should be created for this Search Service. This field cannot be set when using a free sku (see the Microsoft documentation).
    semantic_search_sku str

    Specifies the Semantic Search SKU which should be used for this Search Service. Possible values include free and standard.

    NOTE: The semantic_search_sku cannot be defined if your Search Services sku is set to free. The Semantic Search feature is only available in certain regions, please see the product documentation for more information.

    tags Mapping[str, str]
    Specifies a mapping of tags which should be assigned to this 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 include basic, free, standard, standard2, standard3, storage_optimized_l1 and storage_optimized_l2. Changing this forces a new Search Service to be created.

    The basic and free SKUs provision the Search Service in a Shared Cluster - the standard SKUs use a Dedicated Cluster.

    NOTE: The SKUs standard2, standard3, storage_optimized_l1 and storage_optimized_l2 are only available by submitting a quota increase request to Microsoft. Please see the product documentation on how to submit a quota increase request.

    allowedIps List<String>

    Specifies a list of inbound IPv4 or CIDRs that are allowed to access the Search Service. If the incoming IP request is from an IP address which is not included in the allowed_ips it will be blocked by the Search Services firewall.

    NOTE: The allowed_ips are only applied if the public_network_access_enabled field has been set to true, else all traffic over the public interface will be rejected, even if the allowed_ips field has been defined. When the public_network_access_enabled field has been set to false the private endpoint connections are the only allowed access point to the Search Service.

    authenticationFailureMode String

    Specifies the response that the Search Service should return for requests that fail authentication. Possible values include http401WithBearerChallenge or http403.

    NOTE: authentication_failure_mode can only be configured when using local_authentication_enabled is set to true - which when set together specifies that both API Keys and AzureAD Authentication should be supported.

    customerManagedKeyEnforcementEnabled Boolean
    Specifies whether the Search Service should enforce that non-customer resources are encrypted. Defaults to false.
    hostingMode String

    Specifies the Hosting Mode, which allows for High Density partitions (that allow for up to 1000 indexes) should be supported. Possible values are highDensity or default. Defaults to default. Changing this forces a new Search Service to be created.

    NOTE: hosting_mode can only be configured when sku is set to standard3.

    identity Property Map
    An identity block as defined below.
    localAuthenticationEnabled Boolean
    Specifies whether the Search Service allows authenticating using API Keys? Defaults to true.
    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

    Specifies the number of partitions which should be created. This field cannot be set when using a free or basic sku (see the Microsoft documentation). Possible values include 1, 2, 3, 4, 6, or 12. Defaults to 1.

    NOTE: when hosting_mode is set to highDensity the maximum number of partitions allowed is 3.

    publicNetworkAccessEnabled Boolean
    Specifies whether Public Network Access is allowed for this resource. Defaults to true.
    replicaCount Number
    Specifies the number of Replica's which should be created for this Search Service. This field cannot be set when using a free sku (see the Microsoft documentation).
    semanticSearchSku String

    Specifies the Semantic Search SKU which should be used for this Search Service. Possible values include free and standard.

    NOTE: The semantic_search_sku cannot be defined if your Search Services sku is set to free. The Semantic Search feature is only available in certain regions, please see the product documentation for more information.

    tags Map<String>
    Specifies a mapping of tags which should be assigned to this 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 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 str
    The provider-assigned unique ID for this managed resource.
    primary_key str
    The Primary Key used for Search Service Administration.
    query_keys Sequence[ServiceQueryKey]
    A query_keys block as defined below.
    secondary_key str
    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 List<Property Map>
    A query_keys block as defined below.
    secondaryKey String
    The Secondary Key used for Search Service Administration.

    Look up 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
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        allowed_ips: Optional[Sequence[str]] = None,
        authentication_failure_mode: Optional[str] = None,
        customer_managed_key_enforcement_enabled: Optional[bool] = None,
        hosting_mode: Optional[str] = None,
        identity: Optional[ServiceIdentityArgs] = None,
        local_authentication_enabled: Optional[bool] = None,
        location: Optional[str] = None,
        name: Optional[str] = None,
        partition_count: Optional[int] = None,
        primary_key: Optional[str] = None,
        public_network_access_enabled: Optional[bool] = None,
        query_keys: Optional[Sequence[ServiceQueryKeyArgs]] = None,
        replica_count: Optional[int] = None,
        resource_group_name: Optional[str] = None,
        secondary_key: Optional[str] = None,
        semantic_search_sku: Optional[str] = None,
        sku: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None) -> Service
    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)
    public static Service get(String name, Output<String> id, ServiceState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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.
    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:
    AllowedIps List<string>

    Specifies a list of inbound IPv4 or CIDRs that are allowed to access the Search Service. If the incoming IP request is from an IP address which is not included in the allowed_ips it will be blocked by the Search Services firewall.

    NOTE: The allowed_ips are only applied if the public_network_access_enabled field has been set to true, else all traffic over the public interface will be rejected, even if the allowed_ips field has been defined. When the public_network_access_enabled field has been set to false the private endpoint connections are the only allowed access point to the Search Service.

    AuthenticationFailureMode string

    Specifies the response that the Search Service should return for requests that fail authentication. Possible values include http401WithBearerChallenge or http403.

    NOTE: authentication_failure_mode can only be configured when using local_authentication_enabled is set to true - which when set together specifies that both API Keys and AzureAD Authentication should be supported.

    CustomerManagedKeyEnforcementEnabled bool
    Specifies whether the Search Service should enforce that non-customer resources are encrypted. Defaults to false.
    HostingMode string

    Specifies the Hosting Mode, which allows for High Density partitions (that allow for up to 1000 indexes) should be supported. Possible values are highDensity or default. Defaults to default. Changing this forces a new Search Service to be created.

    NOTE: hosting_mode can only be configured when sku is set to standard3.

    Identity ServiceIdentity
    An identity block as defined below.
    LocalAuthenticationEnabled bool
    Specifies whether the Search Service allows authenticating using API Keys? Defaults to true.
    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

    Specifies the number of partitions which should be created. This field cannot be set when using a free or basic sku (see the Microsoft documentation). Possible values include 1, 2, 3, 4, 6, or 12. Defaults to 1.

    NOTE: when hosting_mode is set to highDensity the maximum number of partitions allowed is 3.

    PrimaryKey string
    The Primary Key used for Search Service Administration.
    PublicNetworkAccessEnabled bool
    Specifies whether Public Network Access is allowed for this resource. Defaults to true.
    QueryKeys List<ServiceQueryKey>
    A query_keys block as defined below.
    ReplicaCount int
    Specifies the number of Replica's which should be created for this Search Service. This field cannot be set when using a free sku (see the Microsoft documentation).
    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.
    SemanticSearchSku string

    Specifies the Semantic Search SKU which should be used for this Search Service. Possible values include free and standard.

    NOTE: The semantic_search_sku cannot be defined if your Search Services sku is set to free. The Semantic Search feature is only available in certain regions, please see the product documentation for more information.

    Sku string

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

    The basic and free SKUs provision the Search Service in a Shared Cluster - the standard SKUs use a Dedicated Cluster.

    NOTE: The SKUs standard2, standard3, storage_optimized_l1 and storage_optimized_l2 are only available by submitting a quota increase request to Microsoft. Please see the product documentation on how to submit a quota increase request.

    Tags Dictionary<string, string>
    Specifies a mapping of tags which should be assigned to this Search Service.
    AllowedIps []string

    Specifies a list of inbound IPv4 or CIDRs that are allowed to access the Search Service. If the incoming IP request is from an IP address which is not included in the allowed_ips it will be blocked by the Search Services firewall.

    NOTE: The allowed_ips are only applied if the public_network_access_enabled field has been set to true, else all traffic over the public interface will be rejected, even if the allowed_ips field has been defined. When the public_network_access_enabled field has been set to false the private endpoint connections are the only allowed access point to the Search Service.

    AuthenticationFailureMode string

    Specifies the response that the Search Service should return for requests that fail authentication. Possible values include http401WithBearerChallenge or http403.

    NOTE: authentication_failure_mode can only be configured when using local_authentication_enabled is set to true - which when set together specifies that both API Keys and AzureAD Authentication should be supported.

    CustomerManagedKeyEnforcementEnabled bool
    Specifies whether the Search Service should enforce that non-customer resources are encrypted. Defaults to false.
    HostingMode string

    Specifies the Hosting Mode, which allows for High Density partitions (that allow for up to 1000 indexes) should be supported. Possible values are highDensity or default. Defaults to default. Changing this forces a new Search Service to be created.

    NOTE: hosting_mode can only be configured when sku is set to standard3.

    Identity ServiceIdentityArgs
    An identity block as defined below.
    LocalAuthenticationEnabled bool
    Specifies whether the Search Service allows authenticating using API Keys? Defaults to true.
    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

    Specifies the number of partitions which should be created. This field cannot be set when using a free or basic sku (see the Microsoft documentation). Possible values include 1, 2, 3, 4, 6, or 12. Defaults to 1.

    NOTE: when hosting_mode is set to highDensity the maximum number of partitions allowed is 3.

    PrimaryKey string
    The Primary Key used for Search Service Administration.
    PublicNetworkAccessEnabled bool
    Specifies whether Public Network Access is allowed for this resource. Defaults to true.
    QueryKeys []ServiceQueryKeyArgs
    A query_keys block as defined below.
    ReplicaCount int
    Specifies the number of Replica's which should be created for this Search Service. This field cannot be set when using a free sku (see the Microsoft documentation).
    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.
    SemanticSearchSku string

    Specifies the Semantic Search SKU which should be used for this Search Service. Possible values include free and standard.

    NOTE: The semantic_search_sku cannot be defined if your Search Services sku is set to free. The Semantic Search feature is only available in certain regions, please see the product documentation for more information.

    Sku string

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

    The basic and free SKUs provision the Search Service in a Shared Cluster - the standard SKUs use a Dedicated Cluster.

    NOTE: The SKUs standard2, standard3, storage_optimized_l1 and storage_optimized_l2 are only available by submitting a quota increase request to Microsoft. Please see the product documentation on how to submit a quota increase request.

    Tags map[string]string
    Specifies a mapping of tags which should be assigned to this Search Service.
    allowedIps List<String>

    Specifies a list of inbound IPv4 or CIDRs that are allowed to access the Search Service. If the incoming IP request is from an IP address which is not included in the allowed_ips it will be blocked by the Search Services firewall.

    NOTE: The allowed_ips are only applied if the public_network_access_enabled field has been set to true, else all traffic over the public interface will be rejected, even if the allowed_ips field has been defined. When the public_network_access_enabled field has been set to false the private endpoint connections are the only allowed access point to the Search Service.

    authenticationFailureMode String

    Specifies the response that the Search Service should return for requests that fail authentication. Possible values include http401WithBearerChallenge or http403.

    NOTE: authentication_failure_mode can only be configured when using local_authentication_enabled is set to true - which when set together specifies that both API Keys and AzureAD Authentication should be supported.

    customerManagedKeyEnforcementEnabled Boolean
    Specifies whether the Search Service should enforce that non-customer resources are encrypted. Defaults to false.
    hostingMode String

    Specifies the Hosting Mode, which allows for High Density partitions (that allow for up to 1000 indexes) should be supported. Possible values are highDensity or default. Defaults to default. Changing this forces a new Search Service to be created.

    NOTE: hosting_mode can only be configured when sku is set to standard3.

    identity ServiceIdentity
    An identity block as defined below.
    localAuthenticationEnabled Boolean
    Specifies whether the Search Service allows authenticating using API Keys? Defaults to true.
    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 Integer

    Specifies the number of partitions which should be created. This field cannot be set when using a free or basic sku (see the Microsoft documentation). Possible values include 1, 2, 3, 4, 6, or 12. Defaults to 1.

    NOTE: when hosting_mode is set to highDensity the maximum number of partitions allowed is 3.

    primaryKey String
    The Primary Key used for Search Service Administration.
    publicNetworkAccessEnabled Boolean
    Specifies whether Public Network Access is allowed for this resource. Defaults to true.
    queryKeys List<ServiceQueryKey>
    A query_keys block as defined below.
    replicaCount Integer
    Specifies the number of Replica's which should be created for this Search Service. This field cannot be set when using a free sku (see the Microsoft documentation).
    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.
    semanticSearchSku String

    Specifies the Semantic Search SKU which should be used for this Search Service. Possible values include free and standard.

    NOTE: The semantic_search_sku cannot be defined if your Search Services sku is set to free. The Semantic Search feature is only available in certain regions, please see the product documentation for more information.

    sku String

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

    The basic and free SKUs provision the Search Service in a Shared Cluster - the standard SKUs use a Dedicated Cluster.

    NOTE: The SKUs standard2, standard3, storage_optimized_l1 and storage_optimized_l2 are only available by submitting a quota increase request to Microsoft. Please see the product documentation on how to submit a quota increase request.

    tags Map<String,String>
    Specifies a mapping of tags which should be assigned to this Search Service.
    allowedIps string[]

    Specifies a list of inbound IPv4 or CIDRs that are allowed to access the Search Service. If the incoming IP request is from an IP address which is not included in the allowed_ips it will be blocked by the Search Services firewall.

    NOTE: The allowed_ips are only applied if the public_network_access_enabled field has been set to true, else all traffic over the public interface will be rejected, even if the allowed_ips field has been defined. When the public_network_access_enabled field has been set to false the private endpoint connections are the only allowed access point to the Search Service.

    authenticationFailureMode string

    Specifies the response that the Search Service should return for requests that fail authentication. Possible values include http401WithBearerChallenge or http403.

    NOTE: authentication_failure_mode can only be configured when using local_authentication_enabled is set to true - which when set together specifies that both API Keys and AzureAD Authentication should be supported.

    customerManagedKeyEnforcementEnabled boolean
    Specifies whether the Search Service should enforce that non-customer resources are encrypted. Defaults to false.
    hostingMode string

    Specifies the Hosting Mode, which allows for High Density partitions (that allow for up to 1000 indexes) should be supported. Possible values are highDensity or default. Defaults to default. Changing this forces a new Search Service to be created.

    NOTE: hosting_mode can only be configured when sku is set to standard3.

    identity ServiceIdentity
    An identity block as defined below.
    localAuthenticationEnabled boolean
    Specifies whether the Search Service allows authenticating using API Keys? Defaults to true.
    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

    Specifies the number of partitions which should be created. This field cannot be set when using a free or basic sku (see the Microsoft documentation). Possible values include 1, 2, 3, 4, 6, or 12. Defaults to 1.

    NOTE: when hosting_mode is set to highDensity the maximum number of partitions allowed is 3.

    primaryKey string
    The Primary Key used for Search Service Administration.
    publicNetworkAccessEnabled boolean
    Specifies whether Public Network Access is allowed for this resource. Defaults to true.
    queryKeys ServiceQueryKey[]
    A query_keys block as defined below.
    replicaCount number
    Specifies the number of Replica's which should be created for this Search Service. This field cannot be set when using a free sku (see the Microsoft documentation).
    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.
    semanticSearchSku string

    Specifies the Semantic Search SKU which should be used for this Search Service. Possible values include free and standard.

    NOTE: The semantic_search_sku cannot be defined if your Search Services sku is set to free. The Semantic Search feature is only available in certain regions, please see the product documentation for more information.

    sku string

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

    The basic and free SKUs provision the Search Service in a Shared Cluster - the standard SKUs use a Dedicated Cluster.

    NOTE: The SKUs standard2, standard3, storage_optimized_l1 and storage_optimized_l2 are only available by submitting a quota increase request to Microsoft. Please see the product documentation on how to submit a quota increase request.

    tags {[key: string]: string}
    Specifies a mapping of tags which should be assigned to this Search Service.
    allowed_ips Sequence[str]

    Specifies a list of inbound IPv4 or CIDRs that are allowed to access the Search Service. If the incoming IP request is from an IP address which is not included in the allowed_ips it will be blocked by the Search Services firewall.

    NOTE: The allowed_ips are only applied if the public_network_access_enabled field has been set to true, else all traffic over the public interface will be rejected, even if the allowed_ips field has been defined. When the public_network_access_enabled field has been set to false the private endpoint connections are the only allowed access point to the Search Service.

    authentication_failure_mode str

    Specifies the response that the Search Service should return for requests that fail authentication. Possible values include http401WithBearerChallenge or http403.

    NOTE: authentication_failure_mode can only be configured when using local_authentication_enabled is set to true - which when set together specifies that both API Keys and AzureAD Authentication should be supported.

    customer_managed_key_enforcement_enabled bool
    Specifies whether the Search Service should enforce that non-customer resources are encrypted. Defaults to false.
    hosting_mode str

    Specifies the Hosting Mode, which allows for High Density partitions (that allow for up to 1000 indexes) should be supported. Possible values are highDensity or default. Defaults to default. Changing this forces a new Search Service to be created.

    NOTE: hosting_mode can only be configured when sku is set to standard3.

    identity ServiceIdentityArgs
    An identity block as defined below.
    local_authentication_enabled bool
    Specifies whether the Search Service allows authenticating using API Keys? Defaults to true.
    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 int

    Specifies the number of partitions which should be created. This field cannot be set when using a free or basic sku (see the Microsoft documentation). Possible values include 1, 2, 3, 4, 6, or 12. Defaults to 1.

    NOTE: when hosting_mode is set to highDensity the maximum number of partitions allowed is 3.

    primary_key str
    The Primary Key used for Search Service Administration.
    public_network_access_enabled bool
    Specifies whether Public Network Access is allowed for this resource. Defaults to true.
    query_keys Sequence[ServiceQueryKeyArgs]
    A query_keys block as defined below.
    replica_count int
    Specifies the number of Replica's which should be created for this Search Service. This field cannot be set when using a free sku (see the Microsoft documentation).
    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.
    semantic_search_sku str

    Specifies the Semantic Search SKU which should be used for this Search Service. Possible values include free and standard.

    NOTE: The semantic_search_sku cannot be defined if your Search Services sku is set to free. The Semantic Search feature is only available in certain regions, please see the product documentation for more information.

    sku str

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

    The basic and free SKUs provision the Search Service in a Shared Cluster - the standard SKUs use a Dedicated Cluster.

    NOTE: The SKUs standard2, standard3, storage_optimized_l1 and storage_optimized_l2 are only available by submitting a quota increase request to Microsoft. Please see the product documentation on how to submit a quota increase request.

    tags Mapping[str, str]
    Specifies a mapping of tags which should be assigned to this Search Service.
    allowedIps List<String>

    Specifies a list of inbound IPv4 or CIDRs that are allowed to access the Search Service. If the incoming IP request is from an IP address which is not included in the allowed_ips it will be blocked by the Search Services firewall.

    NOTE: The allowed_ips are only applied if the public_network_access_enabled field has been set to true, else all traffic over the public interface will be rejected, even if the allowed_ips field has been defined. When the public_network_access_enabled field has been set to false the private endpoint connections are the only allowed access point to the Search Service.

    authenticationFailureMode String

    Specifies the response that the Search Service should return for requests that fail authentication. Possible values include http401WithBearerChallenge or http403.

    NOTE: authentication_failure_mode can only be configured when using local_authentication_enabled is set to true - which when set together specifies that both API Keys and AzureAD Authentication should be supported.

    customerManagedKeyEnforcementEnabled Boolean
    Specifies whether the Search Service should enforce that non-customer resources are encrypted. Defaults to false.
    hostingMode String

    Specifies the Hosting Mode, which allows for High Density partitions (that allow for up to 1000 indexes) should be supported. Possible values are highDensity or default. Defaults to default. Changing this forces a new Search Service to be created.

    NOTE: hosting_mode can only be configured when sku is set to standard3.

    identity Property Map
    An identity block as defined below.
    localAuthenticationEnabled Boolean
    Specifies whether the Search Service allows authenticating using API Keys? Defaults to true.
    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

    Specifies the number of partitions which should be created. This field cannot be set when using a free or basic sku (see the Microsoft documentation). Possible values include 1, 2, 3, 4, 6, or 12. Defaults to 1.

    NOTE: when hosting_mode is set to highDensity the maximum number of partitions allowed is 3.

    primaryKey String
    The Primary Key used for Search Service Administration.
    publicNetworkAccessEnabled Boolean
    Specifies whether Public Network Access is allowed for this resource. Defaults to true.
    queryKeys List<Property Map>
    A query_keys block as defined below.
    replicaCount Number
    Specifies the number of Replica's which should be created for this Search Service. This field cannot be set when using a free sku (see the Microsoft documentation).
    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.
    semanticSearchSku String

    Specifies the Semantic Search SKU which should be used for this Search Service. Possible values include free and standard.

    NOTE: The semantic_search_sku cannot be defined if your Search Services sku is set to free. The Semantic Search feature is only available in certain regions, please see the product documentation for more information.

    sku String

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

    The basic and free SKUs provision the Search Service in a Shared Cluster - the standard SKUs use a Dedicated Cluster.

    NOTE: The SKUs standard2, standard3, storage_optimized_l1 and storage_optimized_l2 are only available by submitting a quota increase request to Microsoft. Please see the product documentation on how to submit a quota increase request.

    tags Map<String>
    Specifies a mapping of tags which should be assigned to this Search Service.

    Supporting Types

    ServiceIdentity, ServiceIdentityArgs

    Type string
    Specifies the type of Managed Service Identity that should be configured on this Search Service. The only possible value is SystemAssigned.
    PrincipalId string
    The Principal ID associated with this Managed Service Identity.
    TenantId string
    The Tenant ID associated with this Managed Service Identity.
    Type string
    Specifies the type of Managed Service Identity that should be configured on this Search Service. The only possible value is SystemAssigned.
    PrincipalId string
    The Principal ID associated with this Managed Service Identity.
    TenantId string
    The Tenant ID associated with this Managed Service Identity.
    type String
    Specifies the type of Managed Service Identity that should be configured on this Search Service. The only possible value is SystemAssigned.
    principalId String
    The Principal ID associated with this Managed Service Identity.
    tenantId String
    The Tenant ID associated with this Managed Service Identity.
    type string
    Specifies the type of Managed Service Identity that should be configured on this Search Service. The only possible value is SystemAssigned.
    principalId string
    The Principal ID associated with this Managed Service Identity.
    tenantId string
    The Tenant ID associated with this Managed Service Identity.
    type str
    Specifies the type of Managed Service Identity that should be configured on this Search Service. The only possible value is SystemAssigned.
    principal_id str
    The Principal ID associated with this Managed Service Identity.
    tenant_id str
    The Tenant ID associated with this Managed Service Identity.
    type String
    Specifies the type of Managed Service Identity that should be configured on this Search Service. The only possible value is SystemAssigned.
    principalId String
    The Principal ID associated with this Managed Service Identity.
    tenantId String
    The Tenant ID associated with this Managed Service Identity.

    ServiceQueryKey, ServiceQueryKeyArgs

    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 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.
    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.

    Import

    Search Services can be imported using the resource id, e.g.

    $ pulumi import azure:search/service:Service example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.Search/searchServices/service1

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azurerm Terraform Provider.
    azure logo

    We recommend using Azure Native.

    Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi
    pulumi/pulumi-azure