pulumi-azure-kotlin/com.pulumi.azure.search.kotlin/ServiceArgs

ServiceArgs

data class ServiceArgs(val allowedIps: Output<List<String>>? = null, val authenticationFailureMode: Output<String>? = null, val customerManagedKeyEnforcementEnabled: Output<Boolean>? = null, val hostingMode: Output<String>? = null, val identity: Output<ServiceIdentityArgs>? = null, val localAuthenticationEnabled: Output<Boolean>? = null, val location: Output<String>? = null, val name: Output<String>? = null, val partitionCount: Output<Int>? = null, val publicNetworkAccessEnabled: Output<Boolean>? = null, val replicaCount: Output<Int>? = null, val resourceGroupName: Output<String>? = null, val semanticSearchSku: Output<String>? = null, val sku: Output<String>? = null, val tags: Output<Map<String, String>>? = null) : ConvertibleToJava<ServiceArgs>

Manages a Search Service.

Example Usage

Supporting API Keys)

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());
    }
}

Using Both AzureAD And API Keys)

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());
    }
}

Supporting Only AzureAD Authentication)

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());
    }
}

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

Constructors

ServiceArgs

fun ServiceArgs(allowedIps: Output<List<String>>? = null, authenticationFailureMode: Output<String>? = null, customerManagedKeyEnforcementEnabled: Output<Boolean>? = null, hostingMode: Output<String>? = null, identity: Output<ServiceIdentityArgs>? = null, localAuthenticationEnabled: Output<Boolean>? = null, location: Output<String>? = null, name: Output<String>? = null, partitionCount: Output<Int>? = null, publicNetworkAccessEnabled: Output<Boolean>? = null, replicaCount: Output<Int>? = null, resourceGroupName: Output<String>? = null, semanticSearchSku: Output<String>? = null, sku: Output<String>? = null, tags: Output<Map<String, String>>? = null)

Functions

toJava

open override fun toJava(): ServiceArgs

Properties

allowedIps

val allowedIps: Output<List<String>>? = null

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.

authenticationFailureMode

val authenticationFailureMode: Output<String>? = null

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

customerManagedKeyEnforcementEnabled

val customerManagedKeyEnforcementEnabled: Output<Boolean>? = null

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

hostingMode

val hostingMode: Output<String>? = null

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.

identity

val identity: Output<ServiceIdentityArgs>? = null

An identity block as defined below.

localAuthenticationEnabled

val localAuthenticationEnabled: Output<Boolean>? = null

Specifies whether the Search Service allows authenticating using API Keys? Defaults to true.

location

val location: Output<String>? = null

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

name

val name: Output<String>? = null

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

partitionCount

val partitionCount: Output<Int>? = null

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.

publicNetworkAccessEnabled

val publicNetworkAccessEnabled: Output<Boolean>? = null

Specifies whether Public Network Access is allowed for this resource. Defaults to true.

replicaCount

val replicaCount: Output<Int>? = null

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

val resourceGroupName: Output<String>? = null

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

semanticSearchSku

val semanticSearchSku: Output<String>? = null

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

sku

val sku: Output<String>? = null

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.