Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. search
  5. Service
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.search.Service

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

Describes a search service and its current state.

Uses Azure REST API version 2023-11-01. In version 2.x of the Azure Native provider, it used API version 2022-09-01.

Other available API versions: 2022-09-01, 2024-03-01-preview, 2024-06-01-preview, 2025-02-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native search [ApiVersion]. See the version guide for details.

Example Usage

SearchCreateOrUpdateService

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

return await Deployment.RunAsync(() => 
{
    var service = new AzureNative.Search.Service("service", new()
    {
        HostingMode = AzureNative.Search.HostingMode.Default,
        Location = "westus",
        PartitionCount = 1,
        ReplicaCount = 3,
        ResourceGroupName = "rg1",
        SearchServiceName = "mysearchservice",
        Sku = new AzureNative.Search.Inputs.SkuArgs
        {
            Name = AzureNative.Search.SkuName.Standard,
        },
        Tags = 
        {
            { "app-name", "My e-commerce app" },
        },
    });

});
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := search.NewService(ctx, "service", &search.ServiceArgs{
			HostingMode:       search.HostingModeDefault,
			Location:          pulumi.String("westus"),
			PartitionCount:    pulumi.Int(1),
			ReplicaCount:      pulumi.Int(3),
			ResourceGroupName: pulumi.String("rg1"),
			SearchServiceName: pulumi.String("mysearchservice"),
			Sku: &search.SkuArgs{
				Name: search.SkuNameStandard,
			},
			Tags: pulumi.StringMap{
				"app-name": pulumi.String("My e-commerce app"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.search.Service;
import com.pulumi.azurenative.search.ServiceArgs;
import com.pulumi.azurenative.search.inputs.SkuArgs;
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 service = new Service("service", ServiceArgs.builder()
            .hostingMode("default")
            .location("westus")
            .partitionCount(1)
            .replicaCount(3)
            .resourceGroupName("rg1")
            .searchServiceName("mysearchservice")
            .sku(SkuArgs.builder()
                .name("standard")
                .build())
            .tags(Map.of("app-name", "My e-commerce app"))
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const service = new azure_native.search.Service("service", {
    hostingMode: azure_native.search.HostingMode.Default,
    location: "westus",
    partitionCount: 1,
    replicaCount: 3,
    resourceGroupName: "rg1",
    searchServiceName: "mysearchservice",
    sku: {
        name: azure_native.search.SkuName.Standard,
    },
    tags: {
        "app-name": "My e-commerce app",
    },
});
Copy
import pulumi
import pulumi_azure_native as azure_native

service = azure_native.search.Service("service",
    hosting_mode=azure_native.search.HostingMode.DEFAULT,
    location="westus",
    partition_count=1,
    replica_count=3,
    resource_group_name="rg1",
    search_service_name="mysearchservice",
    sku={
        "name": azure_native.search.SkuName.STANDARD,
    },
    tags={
        "app-name": "My e-commerce app",
    })
Copy
resources:
  service:
    type: azure-native:search:Service
    properties:
      hostingMode: default
      location: westus
      partitionCount: 1
      replicaCount: 3
      resourceGroupName: rg1
      searchServiceName: mysearchservice
      sku:
        name: standard
      tags:
        app-name: My e-commerce app
Copy

SearchCreateOrUpdateServiceAuthOptions

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

return await Deployment.RunAsync(() => 
{
    var service = new AzureNative.Search.Service("service", new()
    {
        AuthOptions = new AzureNative.Search.Inputs.DataPlaneAuthOptionsArgs
        {
            AadOrApiKey = new AzureNative.Search.Inputs.DataPlaneAadOrApiKeyAuthOptionArgs
            {
                AadAuthFailureMode = AzureNative.Search.AadAuthFailureMode.Http401WithBearerChallenge,
            },
        },
        HostingMode = AzureNative.Search.HostingMode.Default,
        Location = "westus",
        PartitionCount = 1,
        ReplicaCount = 3,
        ResourceGroupName = "rg1",
        SearchServiceName = "mysearchservice",
        Sku = new AzureNative.Search.Inputs.SkuArgs
        {
            Name = AzureNative.Search.SkuName.Standard,
        },
        Tags = 
        {
            { "app-name", "My e-commerce app" },
        },
    });

});
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := search.NewService(ctx, "service", &search.ServiceArgs{
			AuthOptions: &search.DataPlaneAuthOptionsArgs{
				AadOrApiKey: &search.DataPlaneAadOrApiKeyAuthOptionArgs{
					AadAuthFailureMode: search.AadAuthFailureModeHttp401WithBearerChallenge,
				},
			},
			HostingMode:       search.HostingModeDefault,
			Location:          pulumi.String("westus"),
			PartitionCount:    pulumi.Int(1),
			ReplicaCount:      pulumi.Int(3),
			ResourceGroupName: pulumi.String("rg1"),
			SearchServiceName: pulumi.String("mysearchservice"),
			Sku: &search.SkuArgs{
				Name: search.SkuNameStandard,
			},
			Tags: pulumi.StringMap{
				"app-name": pulumi.String("My e-commerce app"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.search.Service;
import com.pulumi.azurenative.search.ServiceArgs;
import com.pulumi.azurenative.search.inputs.DataPlaneAuthOptionsArgs;
import com.pulumi.azurenative.search.inputs.DataPlaneAadOrApiKeyAuthOptionArgs;
import com.pulumi.azurenative.search.inputs.SkuArgs;
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 service = new Service("service", ServiceArgs.builder()
            .authOptions(DataPlaneAuthOptionsArgs.builder()
                .aadOrApiKey(DataPlaneAadOrApiKeyAuthOptionArgs.builder()
                    .aadAuthFailureMode("http401WithBearerChallenge")
                    .build())
                .build())
            .hostingMode("default")
            .location("westus")
            .partitionCount(1)
            .replicaCount(3)
            .resourceGroupName("rg1")
            .searchServiceName("mysearchservice")
            .sku(SkuArgs.builder()
                .name("standard")
                .build())
            .tags(Map.of("app-name", "My e-commerce app"))
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const service = new azure_native.search.Service("service", {
    authOptions: {
        aadOrApiKey: {
            aadAuthFailureMode: azure_native.search.AadAuthFailureMode.Http401WithBearerChallenge,
        },
    },
    hostingMode: azure_native.search.HostingMode.Default,
    location: "westus",
    partitionCount: 1,
    replicaCount: 3,
    resourceGroupName: "rg1",
    searchServiceName: "mysearchservice",
    sku: {
        name: azure_native.search.SkuName.Standard,
    },
    tags: {
        "app-name": "My e-commerce app",
    },
});
Copy
import pulumi
import pulumi_azure_native as azure_native

service = azure_native.search.Service("service",
    auth_options={
        "aad_or_api_key": {
            "aad_auth_failure_mode": azure_native.search.AadAuthFailureMode.HTTP401_WITH_BEARER_CHALLENGE,
        },
    },
    hosting_mode=azure_native.search.HostingMode.DEFAULT,
    location="westus",
    partition_count=1,
    replica_count=3,
    resource_group_name="rg1",
    search_service_name="mysearchservice",
    sku={
        "name": azure_native.search.SkuName.STANDARD,
    },
    tags={
        "app-name": "My e-commerce app",
    })
Copy
resources:
  service:
    type: azure-native:search:Service
    properties:
      authOptions:
        aadOrApiKey:
          aadAuthFailureMode: http401WithBearerChallenge
      hostingMode: default
      location: westus
      partitionCount: 1
      replicaCount: 3
      resourceGroupName: rg1
      searchServiceName: mysearchservice
      sku:
        name: standard
      tags:
        app-name: My e-commerce app
Copy

SearchCreateOrUpdateServiceDisableLocalAuth

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

return await Deployment.RunAsync(() => 
{
    var service = new AzureNative.Search.Service("service", new()
    {
        DisableLocalAuth = true,
        HostingMode = AzureNative.Search.HostingMode.Default,
        Location = "westus",
        PartitionCount = 1,
        ReplicaCount = 3,
        ResourceGroupName = "rg1",
        SearchServiceName = "mysearchservice",
        Sku = new AzureNative.Search.Inputs.SkuArgs
        {
            Name = AzureNative.Search.SkuName.Standard,
        },
        Tags = 
        {
            { "app-name", "My e-commerce app" },
        },
    });

});
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := search.NewService(ctx, "service", &search.ServiceArgs{
			DisableLocalAuth:  pulumi.Bool(true),
			HostingMode:       search.HostingModeDefault,
			Location:          pulumi.String("westus"),
			PartitionCount:    pulumi.Int(1),
			ReplicaCount:      pulumi.Int(3),
			ResourceGroupName: pulumi.String("rg1"),
			SearchServiceName: pulumi.String("mysearchservice"),
			Sku: &search.SkuArgs{
				Name: search.SkuNameStandard,
			},
			Tags: pulumi.StringMap{
				"app-name": pulumi.String("My e-commerce app"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.search.Service;
import com.pulumi.azurenative.search.ServiceArgs;
import com.pulumi.azurenative.search.inputs.SkuArgs;
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 service = new Service("service", ServiceArgs.builder()
            .disableLocalAuth(true)
            .hostingMode("default")
            .location("westus")
            .partitionCount(1)
            .replicaCount(3)
            .resourceGroupName("rg1")
            .searchServiceName("mysearchservice")
            .sku(SkuArgs.builder()
                .name("standard")
                .build())
            .tags(Map.of("app-name", "My e-commerce app"))
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const service = new azure_native.search.Service("service", {
    disableLocalAuth: true,
    hostingMode: azure_native.search.HostingMode.Default,
    location: "westus",
    partitionCount: 1,
    replicaCount: 3,
    resourceGroupName: "rg1",
    searchServiceName: "mysearchservice",
    sku: {
        name: azure_native.search.SkuName.Standard,
    },
    tags: {
        "app-name": "My e-commerce app",
    },
});
Copy
import pulumi
import pulumi_azure_native as azure_native

service = azure_native.search.Service("service",
    disable_local_auth=True,
    hosting_mode=azure_native.search.HostingMode.DEFAULT,
    location="westus",
    partition_count=1,
    replica_count=3,
    resource_group_name="rg1",
    search_service_name="mysearchservice",
    sku={
        "name": azure_native.search.SkuName.STANDARD,
    },
    tags={
        "app-name": "My e-commerce app",
    })
Copy
resources:
  service:
    type: azure-native:search:Service
    properties:
      disableLocalAuth: true
      hostingMode: default
      location: westus
      partitionCount: 1
      replicaCount: 3
      resourceGroupName: rg1
      searchServiceName: mysearchservice
      sku:
        name: standard
      tags:
        app-name: My e-commerce app
Copy

SearchCreateOrUpdateServiceToAllowAccessFromPrivateEndpoints

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

return await Deployment.RunAsync(() => 
{
    var service = new AzureNative.Search.Service("service", new()
    {
        HostingMode = AzureNative.Search.HostingMode.Default,
        Location = "westus",
        PartitionCount = 1,
        PublicNetworkAccess = AzureNative.Search.PublicNetworkAccess.Disabled,
        ReplicaCount = 3,
        ResourceGroupName = "rg1",
        SearchServiceName = "mysearchservice",
        Sku = new AzureNative.Search.Inputs.SkuArgs
        {
            Name = AzureNative.Search.SkuName.Standard,
        },
        Tags = 
        {
            { "app-name", "My e-commerce app" },
        },
    });

});
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := search.NewService(ctx, "service", &search.ServiceArgs{
			HostingMode:         search.HostingModeDefault,
			Location:            pulumi.String("westus"),
			PartitionCount:      pulumi.Int(1),
			PublicNetworkAccess: search.PublicNetworkAccessDisabled,
			ReplicaCount:        pulumi.Int(3),
			ResourceGroupName:   pulumi.String("rg1"),
			SearchServiceName:   pulumi.String("mysearchservice"),
			Sku: &search.SkuArgs{
				Name: search.SkuNameStandard,
			},
			Tags: pulumi.StringMap{
				"app-name": pulumi.String("My e-commerce app"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.search.Service;
import com.pulumi.azurenative.search.ServiceArgs;
import com.pulumi.azurenative.search.inputs.SkuArgs;
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 service = new Service("service", ServiceArgs.builder()
            .hostingMode("default")
            .location("westus")
            .partitionCount(1)
            .publicNetworkAccess("disabled")
            .replicaCount(3)
            .resourceGroupName("rg1")
            .searchServiceName("mysearchservice")
            .sku(SkuArgs.builder()
                .name("standard")
                .build())
            .tags(Map.of("app-name", "My e-commerce app"))
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const service = new azure_native.search.Service("service", {
    hostingMode: azure_native.search.HostingMode.Default,
    location: "westus",
    partitionCount: 1,
    publicNetworkAccess: azure_native.search.PublicNetworkAccess.Disabled,
    replicaCount: 3,
    resourceGroupName: "rg1",
    searchServiceName: "mysearchservice",
    sku: {
        name: azure_native.search.SkuName.Standard,
    },
    tags: {
        "app-name": "My e-commerce app",
    },
});
Copy
import pulumi
import pulumi_azure_native as azure_native

service = azure_native.search.Service("service",
    hosting_mode=azure_native.search.HostingMode.DEFAULT,
    location="westus",
    partition_count=1,
    public_network_access=azure_native.search.PublicNetworkAccess.DISABLED,
    replica_count=3,
    resource_group_name="rg1",
    search_service_name="mysearchservice",
    sku={
        "name": azure_native.search.SkuName.STANDARD,
    },
    tags={
        "app-name": "My e-commerce app",
    })
Copy
resources:
  service:
    type: azure-native:search:Service
    properties:
      hostingMode: default
      location: westus
      partitionCount: 1
      publicNetworkAccess: disabled
      replicaCount: 3
      resourceGroupName: rg1
      searchServiceName: mysearchservice
      sku:
        name: standard
      tags:
        app-name: My e-commerce app
Copy

SearchCreateOrUpdateServiceToAllowAccessFromPublicCustomIPs

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

return await Deployment.RunAsync(() => 
{
    var service = new AzureNative.Search.Service("service", new()
    {
        HostingMode = AzureNative.Search.HostingMode.Default,
        Location = "westus",
        NetworkRuleSet = new AzureNative.Search.Inputs.NetworkRuleSetArgs
        {
            IpRules = new[]
            {
                new AzureNative.Search.Inputs.IpRuleArgs
                {
                    Value = "123.4.5.6",
                },
                new AzureNative.Search.Inputs.IpRuleArgs
                {
                    Value = "123.4.6.0/18",
                },
            },
        },
        PartitionCount = 1,
        ReplicaCount = 1,
        ResourceGroupName = "rg1",
        SearchServiceName = "mysearchservice",
        Sku = new AzureNative.Search.Inputs.SkuArgs
        {
            Name = AzureNative.Search.SkuName.Standard,
        },
        Tags = 
        {
            { "app-name", "My e-commerce app" },
        },
    });

});
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := search.NewService(ctx, "service", &search.ServiceArgs{
			HostingMode: search.HostingModeDefault,
			Location:    pulumi.String("westus"),
			NetworkRuleSet: &search.NetworkRuleSetArgs{
				IpRules: search.IpRuleArray{
					&search.IpRuleArgs{
						Value: pulumi.String("123.4.5.6"),
					},
					&search.IpRuleArgs{
						Value: pulumi.String("123.4.6.0/18"),
					},
				},
			},
			PartitionCount:    pulumi.Int(1),
			ReplicaCount:      pulumi.Int(1),
			ResourceGroupName: pulumi.String("rg1"),
			SearchServiceName: pulumi.String("mysearchservice"),
			Sku: &search.SkuArgs{
				Name: search.SkuNameStandard,
			},
			Tags: pulumi.StringMap{
				"app-name": pulumi.String("My e-commerce app"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.search.Service;
import com.pulumi.azurenative.search.ServiceArgs;
import com.pulumi.azurenative.search.inputs.NetworkRuleSetArgs;
import com.pulumi.azurenative.search.inputs.SkuArgs;
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 service = new Service("service", ServiceArgs.builder()
            .hostingMode("default")
            .location("westus")
            .networkRuleSet(NetworkRuleSetArgs.builder()
                .ipRules(                
                    IpRuleArgs.builder()
                        .value("123.4.5.6")
                        .build(),
                    IpRuleArgs.builder()
                        .value("123.4.6.0/18")
                        .build())
                .build())
            .partitionCount(1)
            .replicaCount(1)
            .resourceGroupName("rg1")
            .searchServiceName("mysearchservice")
            .sku(SkuArgs.builder()
                .name("standard")
                .build())
            .tags(Map.of("app-name", "My e-commerce app"))
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const service = new azure_native.search.Service("service", {
    hostingMode: azure_native.search.HostingMode.Default,
    location: "westus",
    networkRuleSet: {
        ipRules: [
            {
                value: "123.4.5.6",
            },
            {
                value: "123.4.6.0/18",
            },
        ],
    },
    partitionCount: 1,
    replicaCount: 1,
    resourceGroupName: "rg1",
    searchServiceName: "mysearchservice",
    sku: {
        name: azure_native.search.SkuName.Standard,
    },
    tags: {
        "app-name": "My e-commerce app",
    },
});
Copy
import pulumi
import pulumi_azure_native as azure_native

service = azure_native.search.Service("service",
    hosting_mode=azure_native.search.HostingMode.DEFAULT,
    location="westus",
    network_rule_set={
        "ip_rules": [
            {
                "value": "123.4.5.6",
            },
            {
                "value": "123.4.6.0/18",
            },
        ],
    },
    partition_count=1,
    replica_count=1,
    resource_group_name="rg1",
    search_service_name="mysearchservice",
    sku={
        "name": azure_native.search.SkuName.STANDARD,
    },
    tags={
        "app-name": "My e-commerce app",
    })
Copy
resources:
  service:
    type: azure-native:search:Service
    properties:
      hostingMode: default
      location: westus
      networkRuleSet:
        ipRules:
          - value: 123.4.5.6
          - value: 123.4.6.0/18
      partitionCount: 1
      replicaCount: 1
      resourceGroupName: rg1
      searchServiceName: mysearchservice
      sku:
        name: standard
      tags:
        app-name: My e-commerce app
Copy

SearchCreateOrUpdateServiceWithCmkEnforcement

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

return await Deployment.RunAsync(() => 
{
    var service = new AzureNative.Search.Service("service", new()
    {
        EncryptionWithCmk = new AzureNative.Search.Inputs.EncryptionWithCmkArgs
        {
            Enforcement = AzureNative.Search.SearchEncryptionWithCmk.Enabled,
        },
        HostingMode = AzureNative.Search.HostingMode.Default,
        Location = "westus",
        PartitionCount = 1,
        ReplicaCount = 3,
        ResourceGroupName = "rg1",
        SearchServiceName = "mysearchservice",
        Sku = new AzureNative.Search.Inputs.SkuArgs
        {
            Name = AzureNative.Search.SkuName.Standard,
        },
        Tags = 
        {
            { "app-name", "My e-commerce app" },
        },
    });

});
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := search.NewService(ctx, "service", &search.ServiceArgs{
			EncryptionWithCmk: &search.EncryptionWithCmkArgs{
				Enforcement: search.SearchEncryptionWithCmkEnabled,
			},
			HostingMode:       search.HostingModeDefault,
			Location:          pulumi.String("westus"),
			PartitionCount:    pulumi.Int(1),
			ReplicaCount:      pulumi.Int(3),
			ResourceGroupName: pulumi.String("rg1"),
			SearchServiceName: pulumi.String("mysearchservice"),
			Sku: &search.SkuArgs{
				Name: search.SkuNameStandard,
			},
			Tags: pulumi.StringMap{
				"app-name": pulumi.String("My e-commerce app"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.search.Service;
import com.pulumi.azurenative.search.ServiceArgs;
import com.pulumi.azurenative.search.inputs.EncryptionWithCmkArgs;
import com.pulumi.azurenative.search.inputs.SkuArgs;
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 service = new Service("service", ServiceArgs.builder()
            .encryptionWithCmk(EncryptionWithCmkArgs.builder()
                .enforcement("Enabled")
                .build())
            .hostingMode("default")
            .location("westus")
            .partitionCount(1)
            .replicaCount(3)
            .resourceGroupName("rg1")
            .searchServiceName("mysearchservice")
            .sku(SkuArgs.builder()
                .name("standard")
                .build())
            .tags(Map.of("app-name", "My e-commerce app"))
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const service = new azure_native.search.Service("service", {
    encryptionWithCmk: {
        enforcement: azure_native.search.SearchEncryptionWithCmk.Enabled,
    },
    hostingMode: azure_native.search.HostingMode.Default,
    location: "westus",
    partitionCount: 1,
    replicaCount: 3,
    resourceGroupName: "rg1",
    searchServiceName: "mysearchservice",
    sku: {
        name: azure_native.search.SkuName.Standard,
    },
    tags: {
        "app-name": "My e-commerce app",
    },
});
Copy
import pulumi
import pulumi_azure_native as azure_native

service = azure_native.search.Service("service",
    encryption_with_cmk={
        "enforcement": azure_native.search.SearchEncryptionWithCmk.ENABLED,
    },
    hosting_mode=azure_native.search.HostingMode.DEFAULT,
    location="westus",
    partition_count=1,
    replica_count=3,
    resource_group_name="rg1",
    search_service_name="mysearchservice",
    sku={
        "name": azure_native.search.SkuName.STANDARD,
    },
    tags={
        "app-name": "My e-commerce app",
    })
Copy
resources:
  service:
    type: azure-native:search:Service
    properties:
      encryptionWithCmk:
        enforcement: Enabled
      hostingMode: default
      location: westus
      partitionCount: 1
      replicaCount: 3
      resourceGroupName: rg1
      searchServiceName: mysearchservice
      sku:
        name: standard
      tags:
        app-name: My e-commerce app
Copy

SearchCreateOrUpdateServiceWithIdentity

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

return await Deployment.RunAsync(() => 
{
    var service = new AzureNative.Search.Service("service", new()
    {
        HostingMode = AzureNative.Search.HostingMode.Default,
        Identity = new AzureNative.Search.Inputs.IdentityArgs
        {
            Type = AzureNative.Search.IdentityType.SystemAssigned,
        },
        Location = "westus",
        PartitionCount = 1,
        ReplicaCount = 3,
        ResourceGroupName = "rg1",
        SearchServiceName = "mysearchservice",
        Sku = new AzureNative.Search.Inputs.SkuArgs
        {
            Name = AzureNative.Search.SkuName.Standard,
        },
        Tags = 
        {
            { "app-name", "My e-commerce app" },
        },
    });

});
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := search.NewService(ctx, "service", &search.ServiceArgs{
			HostingMode: search.HostingModeDefault,
			Identity: &search.IdentityArgs{
				Type: search.IdentityTypeSystemAssigned,
			},
			Location:          pulumi.String("westus"),
			PartitionCount:    pulumi.Int(1),
			ReplicaCount:      pulumi.Int(3),
			ResourceGroupName: pulumi.String("rg1"),
			SearchServiceName: pulumi.String("mysearchservice"),
			Sku: &search.SkuArgs{
				Name: search.SkuNameStandard,
			},
			Tags: pulumi.StringMap{
				"app-name": pulumi.String("My e-commerce app"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.search.Service;
import com.pulumi.azurenative.search.ServiceArgs;
import com.pulumi.azurenative.search.inputs.IdentityArgs;
import com.pulumi.azurenative.search.inputs.SkuArgs;
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 service = new Service("service", ServiceArgs.builder()
            .hostingMode("default")
            .identity(IdentityArgs.builder()
                .type("SystemAssigned")
                .build())
            .location("westus")
            .partitionCount(1)
            .replicaCount(3)
            .resourceGroupName("rg1")
            .searchServiceName("mysearchservice")
            .sku(SkuArgs.builder()
                .name("standard")
                .build())
            .tags(Map.of("app-name", "My e-commerce app"))
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const service = new azure_native.search.Service("service", {
    hostingMode: azure_native.search.HostingMode.Default,
    identity: {
        type: azure_native.search.IdentityType.SystemAssigned,
    },
    location: "westus",
    partitionCount: 1,
    replicaCount: 3,
    resourceGroupName: "rg1",
    searchServiceName: "mysearchservice",
    sku: {
        name: azure_native.search.SkuName.Standard,
    },
    tags: {
        "app-name": "My e-commerce app",
    },
});
Copy
import pulumi
import pulumi_azure_native as azure_native

service = azure_native.search.Service("service",
    hosting_mode=azure_native.search.HostingMode.DEFAULT,
    identity={
        "type": azure_native.search.IdentityType.SYSTEM_ASSIGNED,
    },
    location="westus",
    partition_count=1,
    replica_count=3,
    resource_group_name="rg1",
    search_service_name="mysearchservice",
    sku={
        "name": azure_native.search.SkuName.STANDARD,
    },
    tags={
        "app-name": "My e-commerce app",
    })
Copy
resources:
  service:
    type: azure-native:search:Service
    properties:
      hostingMode: default
      identity:
        type: SystemAssigned
      location: westus
      partitionCount: 1
      replicaCount: 3
      resourceGroupName: rg1
      searchServiceName: mysearchservice
      sku:
        name: standard
      tags:
        app-name: My e-commerce app
Copy

SearchCreateOrUpdateWithSemanticSearch

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

return await Deployment.RunAsync(() => 
{
    var service = new AzureNative.Search.Service("service", new()
    {
        HostingMode = AzureNative.Search.HostingMode.Default,
        Location = "westus",
        PartitionCount = 1,
        ReplicaCount = 3,
        ResourceGroupName = "rg1",
        SearchServiceName = "mysearchservice",
        SemanticSearch = AzureNative.Search.SearchSemanticSearch.Free,
        Sku = new AzureNative.Search.Inputs.SkuArgs
        {
            Name = AzureNative.Search.SkuName.Standard,
        },
        Tags = 
        {
            { "app-name", "My e-commerce app" },
        },
    });

});
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := search.NewService(ctx, "service", &search.ServiceArgs{
			HostingMode:       search.HostingModeDefault,
			Location:          pulumi.String("westus"),
			PartitionCount:    pulumi.Int(1),
			ReplicaCount:      pulumi.Int(3),
			ResourceGroupName: pulumi.String("rg1"),
			SearchServiceName: pulumi.String("mysearchservice"),
			SemanticSearch:    pulumi.String(search.SearchSemanticSearchFree),
			Sku: &search.SkuArgs{
				Name: search.SkuNameStandard,
			},
			Tags: pulumi.StringMap{
				"app-name": pulumi.String("My e-commerce app"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.search.Service;
import com.pulumi.azurenative.search.ServiceArgs;
import com.pulumi.azurenative.search.inputs.SkuArgs;
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 service = new Service("service", ServiceArgs.builder()
            .hostingMode("default")
            .location("westus")
            .partitionCount(1)
            .replicaCount(3)
            .resourceGroupName("rg1")
            .searchServiceName("mysearchservice")
            .semanticSearch("free")
            .sku(SkuArgs.builder()
                .name("standard")
                .build())
            .tags(Map.of("app-name", "My e-commerce app"))
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const service = new azure_native.search.Service("service", {
    hostingMode: azure_native.search.HostingMode.Default,
    location: "westus",
    partitionCount: 1,
    replicaCount: 3,
    resourceGroupName: "rg1",
    searchServiceName: "mysearchservice",
    semanticSearch: azure_native.search.SearchSemanticSearch.Free,
    sku: {
        name: azure_native.search.SkuName.Standard,
    },
    tags: {
        "app-name": "My e-commerce app",
    },
});
Copy
import pulumi
import pulumi_azure_native as azure_native

service = azure_native.search.Service("service",
    hosting_mode=azure_native.search.HostingMode.DEFAULT,
    location="westus",
    partition_count=1,
    replica_count=3,
    resource_group_name="rg1",
    search_service_name="mysearchservice",
    semantic_search=azure_native.search.SearchSemanticSearch.FREE,
    sku={
        "name": azure_native.search.SkuName.STANDARD,
    },
    tags={
        "app-name": "My e-commerce app",
    })
Copy
resources:
  service:
    type: azure-native:search:Service
    properties:
      hostingMode: default
      location: westus
      partitionCount: 1
      replicaCount: 3
      resourceGroupName: rg1
      searchServiceName: mysearchservice
      semanticSearch: free
      sku:
        name: standard
      tags:
        app-name: My e-commerce app
Copy

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,
            network_rule_set: Optional[NetworkRuleSetArgs] = None,
            public_network_access: Optional[PublicNetworkAccess] = None,
            hosting_mode: Optional[HostingMode] = None,
            identity: Optional[IdentityArgs] = None,
            location: Optional[str] = None,
            auth_options: Optional[DataPlaneAuthOptionsArgs] = None,
            partition_count: Optional[int] = None,
            encryption_with_cmk: Optional[EncryptionWithCmkArgs] = None,
            replica_count: Optional[int] = None,
            disable_local_auth: Optional[bool] = None,
            search_service_name: Optional[str] = None,
            semantic_search: Optional[Union[str, SearchSemanticSearch]] = None,
            sku: Optional[SkuArgs] = 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-native:search:Service
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. ServiceArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. 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 This property is required. string
The unique name of the resource.
args This property is required. ServiceArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ServiceArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. 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 exampleserviceResourceResourceFromSearch = new AzureNative.Search.Service("exampleserviceResourceResourceFromSearch", new()
{
    ResourceGroupName = "string",
    NetworkRuleSet = new AzureNative.Search.Inputs.NetworkRuleSetArgs
    {
        IpRules = new[]
        {
            new AzureNative.Search.Inputs.IpRuleArgs
            {
                Value = "string",
            },
        },
    },
    PublicNetworkAccess = AzureNative.Search.PublicNetworkAccess.Enabled,
    HostingMode = AzureNative.Search.HostingMode.Default,
    Identity = new AzureNative.Search.Inputs.IdentityArgs
    {
        Type = AzureNative.Search.IdentityType.None,
    },
    Location = "string",
    AuthOptions = new AzureNative.Search.Inputs.DataPlaneAuthOptionsArgs
    {
        AadOrApiKey = new AzureNative.Search.Inputs.DataPlaneAadOrApiKeyAuthOptionArgs
        {
            AadAuthFailureMode = AzureNative.Search.AadAuthFailureMode.Http403,
        },
        ApiKeyOnly = "any",
    },
    PartitionCount = 0,
    EncryptionWithCmk = new AzureNative.Search.Inputs.EncryptionWithCmkArgs
    {
        Enforcement = AzureNative.Search.SearchEncryptionWithCmk.Disabled,
    },
    ReplicaCount = 0,
    DisableLocalAuth = false,
    SearchServiceName = "string",
    SemanticSearch = "string",
    Sku = new AzureNative.Search.Inputs.SkuArgs
    {
        Name = AzureNative.Search.SkuName.Free,
    },
    Tags = 
    {
        { "string", "string" },
    },
});
Copy
example, err := search.NewService(ctx, "exampleserviceResourceResourceFromSearch", &search.ServiceArgs{
	ResourceGroupName: pulumi.String("string"),
	NetworkRuleSet: &search.NetworkRuleSetArgs{
		IpRules: search.IpRuleArray{
			&search.IpRuleArgs{
				Value: pulumi.String("string"),
			},
		},
	},
	PublicNetworkAccess: search.PublicNetworkAccessEnabled,
	HostingMode:         search.HostingModeDefault,
	Identity: &search.IdentityArgs{
		Type: search.IdentityTypeNone,
	},
	Location: pulumi.String("string"),
	AuthOptions: &search.DataPlaneAuthOptionsArgs{
		AadOrApiKey: &search.DataPlaneAadOrApiKeyAuthOptionArgs{
			AadAuthFailureMode: search.AadAuthFailureModeHttp403,
		},
		ApiKeyOnly: pulumi.Any("any"),
	},
	PartitionCount: pulumi.Int(0),
	EncryptionWithCmk: &search.EncryptionWithCmkArgs{
		Enforcement: search.SearchEncryptionWithCmkDisabled,
	},
	ReplicaCount:      pulumi.Int(0),
	DisableLocalAuth:  pulumi.Bool(false),
	SearchServiceName: pulumi.String("string"),
	SemanticSearch:    pulumi.String("string"),
	Sku: &search.SkuArgs{
		Name: search.SkuNameFree,
	},
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})
Copy
var exampleserviceResourceResourceFromSearch = new Service("exampleserviceResourceResourceFromSearch", ServiceArgs.builder()
    .resourceGroupName("string")
    .networkRuleSet(NetworkRuleSetArgs.builder()
        .ipRules(IpRuleArgs.builder()
            .value("string")
            .build())
        .build())
    .publicNetworkAccess("enabled")
    .hostingMode("default")
    .identity(IdentityArgs.builder()
        .type("None")
        .build())
    .location("string")
    .authOptions(DataPlaneAuthOptionsArgs.builder()
        .aadOrApiKey(DataPlaneAadOrApiKeyAuthOptionArgs.builder()
            .aadAuthFailureMode("http403")
            .build())
        .apiKeyOnly("any")
        .build())
    .partitionCount(0)
    .encryptionWithCmk(EncryptionWithCmkArgs.builder()
        .enforcement("Disabled")
        .build())
    .replicaCount(0)
    .disableLocalAuth(false)
    .searchServiceName("string")
    .semanticSearch("string")
    .sku(SkuArgs.builder()
        .name("free")
        .build())
    .tags(Map.of("string", "string"))
    .build());
Copy
exampleservice_resource_resource_from_search = azure_native.search.Service("exampleserviceResourceResourceFromSearch",
    resource_group_name="string",
    network_rule_set={
        "ip_rules": [{
            "value": "string",
        }],
    },
    public_network_access=azure_native.search.PublicNetworkAccess.ENABLED,
    hosting_mode=azure_native.search.HostingMode.DEFAULT,
    identity={
        "type": azure_native.search.IdentityType.NONE,
    },
    location="string",
    auth_options={
        "aad_or_api_key": {
            "aad_auth_failure_mode": azure_native.search.AadAuthFailureMode.HTTP403,
        },
        "api_key_only": "any",
    },
    partition_count=0,
    encryption_with_cmk={
        "enforcement": azure_native.search.SearchEncryptionWithCmk.DISABLED,
    },
    replica_count=0,
    disable_local_auth=False,
    search_service_name="string",
    semantic_search="string",
    sku={
        "name": azure_native.search.SkuName.FREE,
    },
    tags={
        "string": "string",
    })
Copy
const exampleserviceResourceResourceFromSearch = new azure_native.search.Service("exampleserviceResourceResourceFromSearch", {
    resourceGroupName: "string",
    networkRuleSet: {
        ipRules: [{
            value: "string",
        }],
    },
    publicNetworkAccess: azure_native.search.PublicNetworkAccess.Enabled,
    hostingMode: azure_native.search.HostingMode.Default,
    identity: {
        type: azure_native.search.IdentityType.None,
    },
    location: "string",
    authOptions: {
        aadOrApiKey: {
            aadAuthFailureMode: azure_native.search.AadAuthFailureMode.Http403,
        },
        apiKeyOnly: "any",
    },
    partitionCount: 0,
    encryptionWithCmk: {
        enforcement: azure_native.search.SearchEncryptionWithCmk.Disabled,
    },
    replicaCount: 0,
    disableLocalAuth: false,
    searchServiceName: "string",
    semanticSearch: "string",
    sku: {
        name: azure_native.search.SkuName.Free,
    },
    tags: {
        string: "string",
    },
});
Copy
type: azure-native:search:Service
properties:
    authOptions:
        aadOrApiKey:
            aadAuthFailureMode: http403
        apiKeyOnly: any
    disableLocalAuth: false
    encryptionWithCmk:
        enforcement: Disabled
    hostingMode: default
    identity:
        type: None
    location: string
    networkRuleSet:
        ipRules:
            - value: string
    partitionCount: 0
    publicNetworkAccess: enabled
    replicaCount: 0
    resourceGroupName: string
    searchServiceName: string
    semanticSearch: string
    sku:
        name: free
    tags:
        string: string
Copy

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
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal.
AuthOptions Pulumi.AzureNative.Search.Inputs.DataPlaneAuthOptions
Defines the options for how the data plane API of a search service authenticates requests. This cannot be set if 'disableLocalAuth' is set to true.
DisableLocalAuth bool
When set to true, calls to the search service will not be permitted to utilize API keys for authentication. This cannot be set to true if 'dataPlaneAuthOptions' are defined.
EncryptionWithCmk Pulumi.AzureNative.Search.Inputs.EncryptionWithCmk
Specifies any policy regarding encryption of resources (such as indexes) using customer manager keys within a search service.
HostingMode Pulumi.AzureNative.Search.HostingMode
Applicable only for the standard3 SKU. You can set this property to enable up to 3 high density partitions that allow up to 1000 indexes, which is much higher than the maximum indexes allowed for any other SKU. For the standard3 SKU, the value is either 'default' or 'highDensity'. For all other SKUs, this value must be 'default'.
Identity Pulumi.AzureNative.Search.Inputs.Identity
The identity of the resource.
Location Changes to this property will trigger replacement. string
The geo-location where the resource lives
NetworkRuleSet Pulumi.AzureNative.Search.Inputs.NetworkRuleSet
Network-specific rules that determine how the search service may be reached.
PartitionCount int
The number of partitions in the search service; if specified, it can be 1, 2, 3, 4, 6, or 12. Values greater than 1 are only valid for standard SKUs. For 'standard3' services with hostingMode set to 'highDensity', the allowed values are between 1 and 3.
PublicNetworkAccess Pulumi.AzureNative.Search.PublicNetworkAccess
This value can be set to 'enabled' to avoid breaking changes on existing customer resources and templates. If set to 'disabled', traffic over public interface is not allowed, and private endpoint connections would be the exclusive access method.
ReplicaCount int
The number of replicas in the search service. If specified, it must be a value between 1 and 12 inclusive for standard SKUs or between 1 and 3 inclusive for basic SKU.
SearchServiceName Changes to this property will trigger replacement. string
The name of the search service to create or update. Search service names must only contain lowercase letters, digits or dashes, cannot use dash as the first two or last one characters, cannot contain consecutive dashes, and must be between 2 and 60 characters in length. Search service names must be globally unique since they are part of the service URI (https://.search.windows.net). You cannot change the service name after the service is created.
SemanticSearch string | Pulumi.AzureNative.Search.SearchSemanticSearch
Sets options that control the availability of semantic search. This configuration is only possible for certain search SKUs in certain locations.
Sku Pulumi.AzureNative.Search.Inputs.Sku
The SKU of the search service, which determines billing rate and capacity limits. This property is required when creating a new search service.
Tags Dictionary<string, string>
Resource tags.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal.
AuthOptions DataPlaneAuthOptionsArgs
Defines the options for how the data plane API of a search service authenticates requests. This cannot be set if 'disableLocalAuth' is set to true.
DisableLocalAuth bool
When set to true, calls to the search service will not be permitted to utilize API keys for authentication. This cannot be set to true if 'dataPlaneAuthOptions' are defined.
EncryptionWithCmk EncryptionWithCmkArgs
Specifies any policy regarding encryption of resources (such as indexes) using customer manager keys within a search service.
HostingMode HostingMode
Applicable only for the standard3 SKU. You can set this property to enable up to 3 high density partitions that allow up to 1000 indexes, which is much higher than the maximum indexes allowed for any other SKU. For the standard3 SKU, the value is either 'default' or 'highDensity'. For all other SKUs, this value must be 'default'.
Identity IdentityArgs
The identity of the resource.
Location Changes to this property will trigger replacement. string
The geo-location where the resource lives
NetworkRuleSet NetworkRuleSetArgs
Network-specific rules that determine how the search service may be reached.
PartitionCount int
The number of partitions in the search service; if specified, it can be 1, 2, 3, 4, 6, or 12. Values greater than 1 are only valid for standard SKUs. For 'standard3' services with hostingMode set to 'highDensity', the allowed values are between 1 and 3.
PublicNetworkAccess PublicNetworkAccess
This value can be set to 'enabled' to avoid breaking changes on existing customer resources and templates. If set to 'disabled', traffic over public interface is not allowed, and private endpoint connections would be the exclusive access method.
ReplicaCount int
The number of replicas in the search service. If specified, it must be a value between 1 and 12 inclusive for standard SKUs or between 1 and 3 inclusive for basic SKU.
SearchServiceName Changes to this property will trigger replacement. string
The name of the search service to create or update. Search service names must only contain lowercase letters, digits or dashes, cannot use dash as the first two or last one characters, cannot contain consecutive dashes, and must be between 2 and 60 characters in length. Search service names must be globally unique since they are part of the service URI (https://.search.windows.net). You cannot change the service name after the service is created.
SemanticSearch string | SearchSemanticSearch
Sets options that control the availability of semantic search. This configuration is only possible for certain search SKUs in certain locations.
Sku SkuArgs
The SKU of the search service, which determines billing rate and capacity limits. This property is required when creating a new search service.
Tags map[string]string
Resource tags.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal.
authOptions DataPlaneAuthOptions
Defines the options for how the data plane API of a search service authenticates requests. This cannot be set if 'disableLocalAuth' is set to true.
disableLocalAuth Boolean
When set to true, calls to the search service will not be permitted to utilize API keys for authentication. This cannot be set to true if 'dataPlaneAuthOptions' are defined.
encryptionWithCmk EncryptionWithCmk
Specifies any policy regarding encryption of resources (such as indexes) using customer manager keys within a search service.
hostingMode HostingMode
Applicable only for the standard3 SKU. You can set this property to enable up to 3 high density partitions that allow up to 1000 indexes, which is much higher than the maximum indexes allowed for any other SKU. For the standard3 SKU, the value is either 'default' or 'highDensity'. For all other SKUs, this value must be 'default'.
identity Identity
The identity of the resource.
location Changes to this property will trigger replacement. String
The geo-location where the resource lives
networkRuleSet NetworkRuleSet
Network-specific rules that determine how the search service may be reached.
partitionCount Integer
The number of partitions in the search service; if specified, it can be 1, 2, 3, 4, 6, or 12. Values greater than 1 are only valid for standard SKUs. For 'standard3' services with hostingMode set to 'highDensity', the allowed values are between 1 and 3.
publicNetworkAccess PublicNetworkAccess
This value can be set to 'enabled' to avoid breaking changes on existing customer resources and templates. If set to 'disabled', traffic over public interface is not allowed, and private endpoint connections would be the exclusive access method.
replicaCount Integer
The number of replicas in the search service. If specified, it must be a value between 1 and 12 inclusive for standard SKUs or between 1 and 3 inclusive for basic SKU.
searchServiceName Changes to this property will trigger replacement. String
The name of the search service to create or update. Search service names must only contain lowercase letters, digits or dashes, cannot use dash as the first two or last one characters, cannot contain consecutive dashes, and must be between 2 and 60 characters in length. Search service names must be globally unique since they are part of the service URI (https://.search.windows.net). You cannot change the service name after the service is created.
semanticSearch String | SearchSemanticSearch
Sets options that control the availability of semantic search. This configuration is only possible for certain search SKUs in certain locations.
sku Sku
The SKU of the search service, which determines billing rate and capacity limits. This property is required when creating a new search service.
tags Map<String,String>
Resource tags.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal.
authOptions DataPlaneAuthOptions
Defines the options for how the data plane API of a search service authenticates requests. This cannot be set if 'disableLocalAuth' is set to true.
disableLocalAuth boolean
When set to true, calls to the search service will not be permitted to utilize API keys for authentication. This cannot be set to true if 'dataPlaneAuthOptions' are defined.
encryptionWithCmk EncryptionWithCmk
Specifies any policy regarding encryption of resources (such as indexes) using customer manager keys within a search service.
hostingMode HostingMode
Applicable only for the standard3 SKU. You can set this property to enable up to 3 high density partitions that allow up to 1000 indexes, which is much higher than the maximum indexes allowed for any other SKU. For the standard3 SKU, the value is either 'default' or 'highDensity'. For all other SKUs, this value must be 'default'.
identity Identity
The identity of the resource.
location Changes to this property will trigger replacement. string
The geo-location where the resource lives
networkRuleSet NetworkRuleSet
Network-specific rules that determine how the search service may be reached.
partitionCount number
The number of partitions in the search service; if specified, it can be 1, 2, 3, 4, 6, or 12. Values greater than 1 are only valid for standard SKUs. For 'standard3' services with hostingMode set to 'highDensity', the allowed values are between 1 and 3.
publicNetworkAccess PublicNetworkAccess
This value can be set to 'enabled' to avoid breaking changes on existing customer resources and templates. If set to 'disabled', traffic over public interface is not allowed, and private endpoint connections would be the exclusive access method.
replicaCount number
The number of replicas in the search service. If specified, it must be a value between 1 and 12 inclusive for standard SKUs or between 1 and 3 inclusive for basic SKU.
searchServiceName Changes to this property will trigger replacement. string
The name of the search service to create or update. Search service names must only contain lowercase letters, digits or dashes, cannot use dash as the first two or last one characters, cannot contain consecutive dashes, and must be between 2 and 60 characters in length. Search service names must be globally unique since they are part of the service URI (https://.search.windows.net). You cannot change the service name after the service is created.
semanticSearch string | SearchSemanticSearch
Sets options that control the availability of semantic search. This configuration is only possible for certain search SKUs in certain locations.
sku Sku
The SKU of the search service, which determines billing rate and capacity limits. This property is required when creating a new search service.
tags {[key: string]: string}
Resource tags.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal.
auth_options DataPlaneAuthOptionsArgs
Defines the options for how the data plane API of a search service authenticates requests. This cannot be set if 'disableLocalAuth' is set to true.
disable_local_auth bool
When set to true, calls to the search service will not be permitted to utilize API keys for authentication. This cannot be set to true if 'dataPlaneAuthOptions' are defined.
encryption_with_cmk EncryptionWithCmkArgs
Specifies any policy regarding encryption of resources (such as indexes) using customer manager keys within a search service.
hosting_mode HostingMode
Applicable only for the standard3 SKU. You can set this property to enable up to 3 high density partitions that allow up to 1000 indexes, which is much higher than the maximum indexes allowed for any other SKU. For the standard3 SKU, the value is either 'default' or 'highDensity'. For all other SKUs, this value must be 'default'.
identity IdentityArgs
The identity of the resource.
location Changes to this property will trigger replacement. str
The geo-location where the resource lives
network_rule_set NetworkRuleSetArgs
Network-specific rules that determine how the search service may be reached.
partition_count int
The number of partitions in the search service; if specified, it can be 1, 2, 3, 4, 6, or 12. Values greater than 1 are only valid for standard SKUs. For 'standard3' services with hostingMode set to 'highDensity', the allowed values are between 1 and 3.
public_network_access PublicNetworkAccess
This value can be set to 'enabled' to avoid breaking changes on existing customer resources and templates. If set to 'disabled', traffic over public interface is not allowed, and private endpoint connections would be the exclusive access method.
replica_count int
The number of replicas in the search service. If specified, it must be a value between 1 and 12 inclusive for standard SKUs or between 1 and 3 inclusive for basic SKU.
search_service_name Changes to this property will trigger replacement. str
The name of the search service to create or update. Search service names must only contain lowercase letters, digits or dashes, cannot use dash as the first two or last one characters, cannot contain consecutive dashes, and must be between 2 and 60 characters in length. Search service names must be globally unique since they are part of the service URI (https://.search.windows.net). You cannot change the service name after the service is created.
semantic_search str | SearchSemanticSearch
Sets options that control the availability of semantic search. This configuration is only possible for certain search SKUs in certain locations.
sku SkuArgs
The SKU of the search service, which determines billing rate and capacity limits. This property is required when creating a new search service.
tags Mapping[str, str]
Resource tags.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal.
authOptions Property Map
Defines the options for how the data plane API of a search service authenticates requests. This cannot be set if 'disableLocalAuth' is set to true.
disableLocalAuth Boolean
When set to true, calls to the search service will not be permitted to utilize API keys for authentication. This cannot be set to true if 'dataPlaneAuthOptions' are defined.
encryptionWithCmk Property Map
Specifies any policy regarding encryption of resources (such as indexes) using customer manager keys within a search service.
hostingMode "default" | "highDensity"
Applicable only for the standard3 SKU. You can set this property to enable up to 3 high density partitions that allow up to 1000 indexes, which is much higher than the maximum indexes allowed for any other SKU. For the standard3 SKU, the value is either 'default' or 'highDensity'. For all other SKUs, this value must be 'default'.
identity Property Map
The identity of the resource.
location Changes to this property will trigger replacement. String
The geo-location where the resource lives
networkRuleSet Property Map
Network-specific rules that determine how the search service may be reached.
partitionCount Number
The number of partitions in the search service; if specified, it can be 1, 2, 3, 4, 6, or 12. Values greater than 1 are only valid for standard SKUs. For 'standard3' services with hostingMode set to 'highDensity', the allowed values are between 1 and 3.
publicNetworkAccess "enabled" | "disabled"
This value can be set to 'enabled' to avoid breaking changes on existing customer resources and templates. If set to 'disabled', traffic over public interface is not allowed, and private endpoint connections would be the exclusive access method.
replicaCount Number
The number of replicas in the search service. If specified, it must be a value between 1 and 12 inclusive for standard SKUs or between 1 and 3 inclusive for basic SKU.
searchServiceName Changes to this property will trigger replacement. String
The name of the search service to create or update. Search service names must only contain lowercase letters, digits or dashes, cannot use dash as the first two or last one characters, cannot contain consecutive dashes, and must be between 2 and 60 characters in length. Search service names must be globally unique since they are part of the service URI (https://.search.windows.net). You cannot change the service name after the service is created.
semanticSearch String | "disabled" | "free" | "standard"
Sets options that control the availability of semantic search. This configuration is only possible for certain search SKUs in certain locations.
sku Property Map
The SKU of the search service, which determines billing rate and capacity limits. This property is required when creating a new search service.
tags Map<String>
Resource tags.

Outputs

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

AzureApiVersion string
The Azure API version of the resource.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the resource
PrivateEndpointConnections List<Pulumi.AzureNative.Search.Outputs.PrivateEndpointConnectionResponse>
The list of private endpoint connections to the search service.
ProvisioningState string
The state of the last provisioning operation performed on the search service. Provisioning is an intermediate state that occurs while service capacity is being established. After capacity is set up, provisioningState changes to either 'succeeded' or 'failed'. Client applications can poll provisioning status (the recommended polling interval is from 30 seconds to one minute) by using the Get Search Service operation to see when an operation is completed. If you are using the free service, this value tends to come back as 'succeeded' directly in the call to Create search service. This is because the free service uses capacity that is already set up.
SharedPrivateLinkResources List<Pulumi.AzureNative.Search.Outputs.SharedPrivateLinkResourceResponse>
The list of shared private link resources managed by the search service.
Status string
The status of the search service. Possible values include: 'running': The search service is running and no provisioning operations are underway. 'provisioning': The search service is being provisioned or scaled up or down. 'deleting': The search service is being deleted. 'degraded': The search service is degraded. This can occur when the underlying search units are not healthy. The search service is most likely operational, but performance might be slow and some requests might be dropped. 'disabled': The search service is disabled. In this state, the service will reject all API requests. 'error': The search service is in an error state. If your service is in the degraded, disabled, or error states, Microsoft is actively investigating the underlying issue. Dedicated services in these states are still chargeable based on the number of search units provisioned.
StatusDetails string
The details of the search service status.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
AzureApiVersion string
The Azure API version of the resource.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the resource
PrivateEndpointConnections []PrivateEndpointConnectionResponse
The list of private endpoint connections to the search service.
ProvisioningState string
The state of the last provisioning operation performed on the search service. Provisioning is an intermediate state that occurs while service capacity is being established. After capacity is set up, provisioningState changes to either 'succeeded' or 'failed'. Client applications can poll provisioning status (the recommended polling interval is from 30 seconds to one minute) by using the Get Search Service operation to see when an operation is completed. If you are using the free service, this value tends to come back as 'succeeded' directly in the call to Create search service. This is because the free service uses capacity that is already set up.
SharedPrivateLinkResources []SharedPrivateLinkResourceResponse
The list of shared private link resources managed by the search service.
Status string
The status of the search service. Possible values include: 'running': The search service is running and no provisioning operations are underway. 'provisioning': The search service is being provisioned or scaled up or down. 'deleting': The search service is being deleted. 'degraded': The search service is degraded. This can occur when the underlying search units are not healthy. The search service is most likely operational, but performance might be slow and some requests might be dropped. 'disabled': The search service is disabled. In this state, the service will reject all API requests. 'error': The search service is in an error state. If your service is in the degraded, disabled, or error states, Microsoft is actively investigating the underlying issue. Dedicated services in these states are still chargeable based on the number of search units provisioned.
StatusDetails string
The details of the search service status.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
azureApiVersion String
The Azure API version of the resource.
id String
The provider-assigned unique ID for this managed resource.
name String
The name of the resource
privateEndpointConnections List<PrivateEndpointConnectionResponse>
The list of private endpoint connections to the search service.
provisioningState String
The state of the last provisioning operation performed on the search service. Provisioning is an intermediate state that occurs while service capacity is being established. After capacity is set up, provisioningState changes to either 'succeeded' or 'failed'. Client applications can poll provisioning status (the recommended polling interval is from 30 seconds to one minute) by using the Get Search Service operation to see when an operation is completed. If you are using the free service, this value tends to come back as 'succeeded' directly in the call to Create search service. This is because the free service uses capacity that is already set up.
sharedPrivateLinkResources List<SharedPrivateLinkResourceResponse>
The list of shared private link resources managed by the search service.
status String
The status of the search service. Possible values include: 'running': The search service is running and no provisioning operations are underway. 'provisioning': The search service is being provisioned or scaled up or down. 'deleting': The search service is being deleted. 'degraded': The search service is degraded. This can occur when the underlying search units are not healthy. The search service is most likely operational, but performance might be slow and some requests might be dropped. 'disabled': The search service is disabled. In this state, the service will reject all API requests. 'error': The search service is in an error state. If your service is in the degraded, disabled, or error states, Microsoft is actively investigating the underlying issue. Dedicated services in these states are still chargeable based on the number of search units provisioned.
statusDetails String
The details of the search service status.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
azureApiVersion string
The Azure API version of the resource.
id string
The provider-assigned unique ID for this managed resource.
name string
The name of the resource
privateEndpointConnections PrivateEndpointConnectionResponse[]
The list of private endpoint connections to the search service.
provisioningState string
The state of the last provisioning operation performed on the search service. Provisioning is an intermediate state that occurs while service capacity is being established. After capacity is set up, provisioningState changes to either 'succeeded' or 'failed'. Client applications can poll provisioning status (the recommended polling interval is from 30 seconds to one minute) by using the Get Search Service operation to see when an operation is completed. If you are using the free service, this value tends to come back as 'succeeded' directly in the call to Create search service. This is because the free service uses capacity that is already set up.
sharedPrivateLinkResources SharedPrivateLinkResourceResponse[]
The list of shared private link resources managed by the search service.
status string
The status of the search service. Possible values include: 'running': The search service is running and no provisioning operations are underway. 'provisioning': The search service is being provisioned or scaled up or down. 'deleting': The search service is being deleted. 'degraded': The search service is degraded. This can occur when the underlying search units are not healthy. The search service is most likely operational, but performance might be slow and some requests might be dropped. 'disabled': The search service is disabled. In this state, the service will reject all API requests. 'error': The search service is in an error state. If your service is in the degraded, disabled, or error states, Microsoft is actively investigating the underlying issue. Dedicated services in these states are still chargeable based on the number of search units provisioned.
statusDetails string
The details of the search service status.
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
azure_api_version str
The Azure API version of the resource.
id str
The provider-assigned unique ID for this managed resource.
name str
The name of the resource
private_endpoint_connections Sequence[PrivateEndpointConnectionResponse]
The list of private endpoint connections to the search service.
provisioning_state str
The state of the last provisioning operation performed on the search service. Provisioning is an intermediate state that occurs while service capacity is being established. After capacity is set up, provisioningState changes to either 'succeeded' or 'failed'. Client applications can poll provisioning status (the recommended polling interval is from 30 seconds to one minute) by using the Get Search Service operation to see when an operation is completed. If you are using the free service, this value tends to come back as 'succeeded' directly in the call to Create search service. This is because the free service uses capacity that is already set up.
shared_private_link_resources Sequence[SharedPrivateLinkResourceResponse]
The list of shared private link resources managed by the search service.
status str
The status of the search service. Possible values include: 'running': The search service is running and no provisioning operations are underway. 'provisioning': The search service is being provisioned or scaled up or down. 'deleting': The search service is being deleted. 'degraded': The search service is degraded. This can occur when the underlying search units are not healthy. The search service is most likely operational, but performance might be slow and some requests might be dropped. 'disabled': The search service is disabled. In this state, the service will reject all API requests. 'error': The search service is in an error state. If your service is in the degraded, disabled, or error states, Microsoft is actively investigating the underlying issue. Dedicated services in these states are still chargeable based on the number of search units provisioned.
status_details str
The details of the search service status.
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
azureApiVersion String
The Azure API version of the resource.
id String
The provider-assigned unique ID for this managed resource.
name String
The name of the resource
privateEndpointConnections List<Property Map>
The list of private endpoint connections to the search service.
provisioningState String
The state of the last provisioning operation performed on the search service. Provisioning is an intermediate state that occurs while service capacity is being established. After capacity is set up, provisioningState changes to either 'succeeded' or 'failed'. Client applications can poll provisioning status (the recommended polling interval is from 30 seconds to one minute) by using the Get Search Service operation to see when an operation is completed. If you are using the free service, this value tends to come back as 'succeeded' directly in the call to Create search service. This is because the free service uses capacity that is already set up.
sharedPrivateLinkResources List<Property Map>
The list of shared private link resources managed by the search service.
status String
The status of the search service. Possible values include: 'running': The search service is running and no provisioning operations are underway. 'provisioning': The search service is being provisioned or scaled up or down. 'deleting': The search service is being deleted. 'degraded': The search service is degraded. This can occur when the underlying search units are not healthy. The search service is most likely operational, but performance might be slow and some requests might be dropped. 'disabled': The search service is disabled. In this state, the service will reject all API requests. 'error': The search service is in an error state. If your service is in the degraded, disabled, or error states, Microsoft is actively investigating the underlying issue. Dedicated services in these states are still chargeable based on the number of search units provisioned.
statusDetails String
The details of the search service status.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Supporting Types

AadAuthFailureMode
, AadAuthFailureModeArgs

Http403
http403Indicates that requests that failed authentication should be presented with an HTTP status code of 403 (Forbidden).
Http401WithBearerChallenge
http401WithBearerChallengeIndicates that requests that failed authentication should be presented with an HTTP status code of 401 (Unauthorized) and present a Bearer Challenge.
AadAuthFailureModeHttp403
http403Indicates that requests that failed authentication should be presented with an HTTP status code of 403 (Forbidden).
AadAuthFailureModeHttp401WithBearerChallenge
http401WithBearerChallengeIndicates that requests that failed authentication should be presented with an HTTP status code of 401 (Unauthorized) and present a Bearer Challenge.
Http403
http403Indicates that requests that failed authentication should be presented with an HTTP status code of 403 (Forbidden).
Http401WithBearerChallenge
http401WithBearerChallengeIndicates that requests that failed authentication should be presented with an HTTP status code of 401 (Unauthorized) and present a Bearer Challenge.
Http403
http403Indicates that requests that failed authentication should be presented with an HTTP status code of 403 (Forbidden).
Http401WithBearerChallenge
http401WithBearerChallengeIndicates that requests that failed authentication should be presented with an HTTP status code of 401 (Unauthorized) and present a Bearer Challenge.
HTTP403
http403Indicates that requests that failed authentication should be presented with an HTTP status code of 403 (Forbidden).
HTTP401_WITH_BEARER_CHALLENGE
http401WithBearerChallengeIndicates that requests that failed authentication should be presented with an HTTP status code of 401 (Unauthorized) and present a Bearer Challenge.
"http403"
http403Indicates that requests that failed authentication should be presented with an HTTP status code of 403 (Forbidden).
"http401WithBearerChallenge"
http401WithBearerChallengeIndicates that requests that failed authentication should be presented with an HTTP status code of 401 (Unauthorized) and present a Bearer Challenge.

DataPlaneAadOrApiKeyAuthOption
, DataPlaneAadOrApiKeyAuthOptionArgs

AadAuthFailureMode Pulumi.AzureNative.Search.AadAuthFailureMode
Describes what response the data plane API of a search service would send for requests that failed authentication.
AadAuthFailureMode AadAuthFailureMode
Describes what response the data plane API of a search service would send for requests that failed authentication.
aadAuthFailureMode AadAuthFailureMode
Describes what response the data plane API of a search service would send for requests that failed authentication.
aadAuthFailureMode AadAuthFailureMode
Describes what response the data plane API of a search service would send for requests that failed authentication.
aad_auth_failure_mode AadAuthFailureMode
Describes what response the data plane API of a search service would send for requests that failed authentication.
aadAuthFailureMode "http403" | "http401WithBearerChallenge"
Describes what response the data plane API of a search service would send for requests that failed authentication.

DataPlaneAadOrApiKeyAuthOptionResponse
, DataPlaneAadOrApiKeyAuthOptionResponseArgs

AadAuthFailureMode string
Describes what response the data plane API of a search service would send for requests that failed authentication.
AadAuthFailureMode string
Describes what response the data plane API of a search service would send for requests that failed authentication.
aadAuthFailureMode String
Describes what response the data plane API of a search service would send for requests that failed authentication.
aadAuthFailureMode string
Describes what response the data plane API of a search service would send for requests that failed authentication.
aad_auth_failure_mode str
Describes what response the data plane API of a search service would send for requests that failed authentication.
aadAuthFailureMode String
Describes what response the data plane API of a search service would send for requests that failed authentication.

DataPlaneAuthOptions
, DataPlaneAuthOptionsArgs

AadOrApiKey Pulumi.AzureNative.Search.Inputs.DataPlaneAadOrApiKeyAuthOption
Indicates that either the API key or an access token from a Microsoft Entra ID tenant can be used for authentication.
ApiKeyOnly object
Indicates that only the API key can be used for authentication.
AadOrApiKey DataPlaneAadOrApiKeyAuthOption
Indicates that either the API key or an access token from a Microsoft Entra ID tenant can be used for authentication.
ApiKeyOnly interface{}
Indicates that only the API key can be used for authentication.
aadOrApiKey DataPlaneAadOrApiKeyAuthOption
Indicates that either the API key or an access token from a Microsoft Entra ID tenant can be used for authentication.
apiKeyOnly Object
Indicates that only the API key can be used for authentication.
aadOrApiKey DataPlaneAadOrApiKeyAuthOption
Indicates that either the API key or an access token from a Microsoft Entra ID tenant can be used for authentication.
apiKeyOnly any
Indicates that only the API key can be used for authentication.
aad_or_api_key DataPlaneAadOrApiKeyAuthOption
Indicates that either the API key or an access token from a Microsoft Entra ID tenant can be used for authentication.
api_key_only Any
Indicates that only the API key can be used for authentication.
aadOrApiKey Property Map
Indicates that either the API key or an access token from a Microsoft Entra ID tenant can be used for authentication.
apiKeyOnly Any
Indicates that only the API key can be used for authentication.

DataPlaneAuthOptionsResponse
, DataPlaneAuthOptionsResponseArgs

AadOrApiKey Pulumi.AzureNative.Search.Inputs.DataPlaneAadOrApiKeyAuthOptionResponse
Indicates that either the API key or an access token from a Microsoft Entra ID tenant can be used for authentication.
ApiKeyOnly object
Indicates that only the API key can be used for authentication.
AadOrApiKey DataPlaneAadOrApiKeyAuthOptionResponse
Indicates that either the API key or an access token from a Microsoft Entra ID tenant can be used for authentication.
ApiKeyOnly interface{}
Indicates that only the API key can be used for authentication.
aadOrApiKey DataPlaneAadOrApiKeyAuthOptionResponse
Indicates that either the API key or an access token from a Microsoft Entra ID tenant can be used for authentication.
apiKeyOnly Object
Indicates that only the API key can be used for authentication.
aadOrApiKey DataPlaneAadOrApiKeyAuthOptionResponse
Indicates that either the API key or an access token from a Microsoft Entra ID tenant can be used for authentication.
apiKeyOnly any
Indicates that only the API key can be used for authentication.
aad_or_api_key DataPlaneAadOrApiKeyAuthOptionResponse
Indicates that either the API key or an access token from a Microsoft Entra ID tenant can be used for authentication.
api_key_only Any
Indicates that only the API key can be used for authentication.
aadOrApiKey Property Map
Indicates that either the API key or an access token from a Microsoft Entra ID tenant can be used for authentication.
apiKeyOnly Any
Indicates that only the API key can be used for authentication.

EncryptionWithCmk
, EncryptionWithCmkArgs

Enforcement Pulumi.AzureNative.Search.SearchEncryptionWithCmk
Describes how a search service should enforce having one or more non-customer-encrypted resources.
Enforcement SearchEncryptionWithCmk
Describes how a search service should enforce having one or more non-customer-encrypted resources.
enforcement SearchEncryptionWithCmk
Describes how a search service should enforce having one or more non-customer-encrypted resources.
enforcement SearchEncryptionWithCmk
Describes how a search service should enforce having one or more non-customer-encrypted resources.
enforcement SearchEncryptionWithCmk
Describes how a search service should enforce having one or more non-customer-encrypted resources.
enforcement "Disabled" | "Enabled" | "Unspecified"
Describes how a search service should enforce having one or more non-customer-encrypted resources.

EncryptionWithCmkResponse
, EncryptionWithCmkResponseArgs

EncryptionComplianceStatus This property is required. string
Describes whether the search service is compliant or not with respect to having non-customer-encrypted resources. If a service has more than one non-customer-encrypted resource and 'Enforcement' is 'enabled' then the service will be marked as 'nonCompliant'.
Enforcement string
Describes how a search service should enforce having one or more non-customer-encrypted resources.
EncryptionComplianceStatus This property is required. string
Describes whether the search service is compliant or not with respect to having non-customer-encrypted resources. If a service has more than one non-customer-encrypted resource and 'Enforcement' is 'enabled' then the service will be marked as 'nonCompliant'.
Enforcement string
Describes how a search service should enforce having one or more non-customer-encrypted resources.
encryptionComplianceStatus This property is required. String
Describes whether the search service is compliant or not with respect to having non-customer-encrypted resources. If a service has more than one non-customer-encrypted resource and 'Enforcement' is 'enabled' then the service will be marked as 'nonCompliant'.
enforcement String
Describes how a search service should enforce having one or more non-customer-encrypted resources.
encryptionComplianceStatus This property is required. string
Describes whether the search service is compliant or not with respect to having non-customer-encrypted resources. If a service has more than one non-customer-encrypted resource and 'Enforcement' is 'enabled' then the service will be marked as 'nonCompliant'.
enforcement string
Describes how a search service should enforce having one or more non-customer-encrypted resources.
encryption_compliance_status This property is required. str
Describes whether the search service is compliant or not with respect to having non-customer-encrypted resources. If a service has more than one non-customer-encrypted resource and 'Enforcement' is 'enabled' then the service will be marked as 'nonCompliant'.
enforcement str
Describes how a search service should enforce having one or more non-customer-encrypted resources.
encryptionComplianceStatus This property is required. String
Describes whether the search service is compliant or not with respect to having non-customer-encrypted resources. If a service has more than one non-customer-encrypted resource and 'Enforcement' is 'enabled' then the service will be marked as 'nonCompliant'.
enforcement String
Describes how a search service should enforce having one or more non-customer-encrypted resources.

HostingMode
, HostingModeArgs

Default
defaultThe limit on number of indexes is determined by the default limits for the SKU.
HighDensity
highDensityOnly application for standard3 SKU, where the search service can have up to 1000 indexes.
HostingModeDefault
defaultThe limit on number of indexes is determined by the default limits for the SKU.
HostingModeHighDensity
highDensityOnly application for standard3 SKU, where the search service can have up to 1000 indexes.
Default
defaultThe limit on number of indexes is determined by the default limits for the SKU.
HighDensity
highDensityOnly application for standard3 SKU, where the search service can have up to 1000 indexes.
Default
defaultThe limit on number of indexes is determined by the default limits for the SKU.
HighDensity
highDensityOnly application for standard3 SKU, where the search service can have up to 1000 indexes.
DEFAULT
defaultThe limit on number of indexes is determined by the default limits for the SKU.
HIGH_DENSITY
highDensityOnly application for standard3 SKU, where the search service can have up to 1000 indexes.
"default"
defaultThe limit on number of indexes is determined by the default limits for the SKU.
"highDensity"
highDensityOnly application for standard3 SKU, where the search service can have up to 1000 indexes.

Identity
, IdentityArgs

Type This property is required. Pulumi.AzureNative.Search.IdentityType
The identity type.
Type This property is required. IdentityType
The identity type.
type This property is required. IdentityType
The identity type.
type This property is required. IdentityType
The identity type.
type This property is required. IdentityType
The identity type.
type This property is required. "None" | "SystemAssigned"
The identity type.

IdentityResponse
, IdentityResponseArgs

PrincipalId This property is required. string
The principal ID of the system-assigned identity of the search service.
TenantId This property is required. string
The tenant ID of the system-assigned identity of the search service.
Type This property is required. string
The identity type.
PrincipalId This property is required. string
The principal ID of the system-assigned identity of the search service.
TenantId This property is required. string
The tenant ID of the system-assigned identity of the search service.
Type This property is required. string
The identity type.
principalId This property is required. String
The principal ID of the system-assigned identity of the search service.
tenantId This property is required. String
The tenant ID of the system-assigned identity of the search service.
type This property is required. String
The identity type.
principalId This property is required. string
The principal ID of the system-assigned identity of the search service.
tenantId This property is required. string
The tenant ID of the system-assigned identity of the search service.
type This property is required. string
The identity type.
principal_id This property is required. str
The principal ID of the system-assigned identity of the search service.
tenant_id This property is required. str
The tenant ID of the system-assigned identity of the search service.
type This property is required. str
The identity type.
principalId This property is required. String
The principal ID of the system-assigned identity of the search service.
tenantId This property is required. String
The tenant ID of the system-assigned identity of the search service.
type This property is required. String
The identity type.

IdentityType
, IdentityTypeArgs

None
None
SystemAssigned
SystemAssigned
IdentityTypeNone
None
IdentityTypeSystemAssigned
SystemAssigned
None
None
SystemAssigned
SystemAssigned
None
None
SystemAssigned
SystemAssigned
NONE
None
SYSTEM_ASSIGNED
SystemAssigned
"None"
None
"SystemAssigned"
SystemAssigned

IpRule
, IpRuleArgs

Value string
Value corresponding to a single IPv4 address (for example, 123.1.2.3) or an IP range in CIDR format (for example, 123.1.2.3/24) to be allowed.
Value string
Value corresponding to a single IPv4 address (for example, 123.1.2.3) or an IP range in CIDR format (for example, 123.1.2.3/24) to be allowed.
value String
Value corresponding to a single IPv4 address (for example, 123.1.2.3) or an IP range in CIDR format (for example, 123.1.2.3/24) to be allowed.
value string
Value corresponding to a single IPv4 address (for example, 123.1.2.3) or an IP range in CIDR format (for example, 123.1.2.3/24) to be allowed.
value str
Value corresponding to a single IPv4 address (for example, 123.1.2.3) or an IP range in CIDR format (for example, 123.1.2.3/24) to be allowed.
value String
Value corresponding to a single IPv4 address (for example, 123.1.2.3) or an IP range in CIDR format (for example, 123.1.2.3/24) to be allowed.

IpRuleResponse
, IpRuleResponseArgs

Value string
Value corresponding to a single IPv4 address (for example, 123.1.2.3) or an IP range in CIDR format (for example, 123.1.2.3/24) to be allowed.
Value string
Value corresponding to a single IPv4 address (for example, 123.1.2.3) or an IP range in CIDR format (for example, 123.1.2.3/24) to be allowed.
value String
Value corresponding to a single IPv4 address (for example, 123.1.2.3) or an IP range in CIDR format (for example, 123.1.2.3/24) to be allowed.
value string
Value corresponding to a single IPv4 address (for example, 123.1.2.3) or an IP range in CIDR format (for example, 123.1.2.3/24) to be allowed.
value str
Value corresponding to a single IPv4 address (for example, 123.1.2.3) or an IP range in CIDR format (for example, 123.1.2.3/24) to be allowed.
value String
Value corresponding to a single IPv4 address (for example, 123.1.2.3) or an IP range in CIDR format (for example, 123.1.2.3/24) to be allowed.

NetworkRuleSet
, NetworkRuleSetArgs

IpRules List<Pulumi.AzureNative.Search.Inputs.IpRule>
A list of IP restriction rules used for an IP firewall. Any IPs that do not match the rules are blocked by the firewall. These rules are only applied when the 'publicNetworkAccess' of the search service is 'enabled'.
IpRules []IpRule
A list of IP restriction rules used for an IP firewall. Any IPs that do not match the rules are blocked by the firewall. These rules are only applied when the 'publicNetworkAccess' of the search service is 'enabled'.
ipRules List<IpRule>
A list of IP restriction rules used for an IP firewall. Any IPs that do not match the rules are blocked by the firewall. These rules are only applied when the 'publicNetworkAccess' of the search service is 'enabled'.
ipRules IpRule[]
A list of IP restriction rules used for an IP firewall. Any IPs that do not match the rules are blocked by the firewall. These rules are only applied when the 'publicNetworkAccess' of the search service is 'enabled'.
ip_rules Sequence[IpRule]
A list of IP restriction rules used for an IP firewall. Any IPs that do not match the rules are blocked by the firewall. These rules are only applied when the 'publicNetworkAccess' of the search service is 'enabled'.
ipRules List<Property Map>
A list of IP restriction rules used for an IP firewall. Any IPs that do not match the rules are blocked by the firewall. These rules are only applied when the 'publicNetworkAccess' of the search service is 'enabled'.

NetworkRuleSetResponse
, NetworkRuleSetResponseArgs

IpRules List<Pulumi.AzureNative.Search.Inputs.IpRuleResponse>
A list of IP restriction rules used for an IP firewall. Any IPs that do not match the rules are blocked by the firewall. These rules are only applied when the 'publicNetworkAccess' of the search service is 'enabled'.
IpRules []IpRuleResponse
A list of IP restriction rules used for an IP firewall. Any IPs that do not match the rules are blocked by the firewall. These rules are only applied when the 'publicNetworkAccess' of the search service is 'enabled'.
ipRules List<IpRuleResponse>
A list of IP restriction rules used for an IP firewall. Any IPs that do not match the rules are blocked by the firewall. These rules are only applied when the 'publicNetworkAccess' of the search service is 'enabled'.
ipRules IpRuleResponse[]
A list of IP restriction rules used for an IP firewall. Any IPs that do not match the rules are blocked by the firewall. These rules are only applied when the 'publicNetworkAccess' of the search service is 'enabled'.
ip_rules Sequence[IpRuleResponse]
A list of IP restriction rules used for an IP firewall. Any IPs that do not match the rules are blocked by the firewall. These rules are only applied when the 'publicNetworkAccess' of the search service is 'enabled'.
ipRules List<Property Map>
A list of IP restriction rules used for an IP firewall. Any IPs that do not match the rules are blocked by the firewall. These rules are only applied when the 'publicNetworkAccess' of the search service is 'enabled'.

PrivateEndpointConnectionPropertiesResponse
, PrivateEndpointConnectionPropertiesResponseArgs

GroupId string
The group id from the provider of resource the private link service connection is for.
PrivateEndpoint Pulumi.AzureNative.Search.Inputs.PrivateEndpointConnectionPropertiesResponsePrivateEndpoint
The private endpoint resource from Microsoft.Network provider.
PrivateLinkServiceConnectionState Pulumi.AzureNative.Search.Inputs.PrivateEndpointConnectionPropertiesResponsePrivateLinkServiceConnectionState
Describes the current state of an existing Private Link Service connection to the Azure Private Endpoint.
ProvisioningState string
The provisioning state of the private link service connection. Valid values are Updating, Deleting, Failed, Succeeded, or Incomplete
GroupId string
The group id from the provider of resource the private link service connection is for.
PrivateEndpoint PrivateEndpointConnectionPropertiesResponsePrivateEndpoint
The private endpoint resource from Microsoft.Network provider.
PrivateLinkServiceConnectionState PrivateEndpointConnectionPropertiesResponsePrivateLinkServiceConnectionState
Describes the current state of an existing Private Link Service connection to the Azure Private Endpoint.
ProvisioningState string
The provisioning state of the private link service connection. Valid values are Updating, Deleting, Failed, Succeeded, or Incomplete
groupId String
The group id from the provider of resource the private link service connection is for.
privateEndpoint PrivateEndpointConnectionPropertiesResponsePrivateEndpoint
The private endpoint resource from Microsoft.Network provider.
privateLinkServiceConnectionState PrivateEndpointConnectionPropertiesResponsePrivateLinkServiceConnectionState
Describes the current state of an existing Private Link Service connection to the Azure Private Endpoint.
provisioningState String
The provisioning state of the private link service connection. Valid values are Updating, Deleting, Failed, Succeeded, or Incomplete
groupId string
The group id from the provider of resource the private link service connection is for.
privateEndpoint PrivateEndpointConnectionPropertiesResponsePrivateEndpoint
The private endpoint resource from Microsoft.Network provider.
privateLinkServiceConnectionState PrivateEndpointConnectionPropertiesResponsePrivateLinkServiceConnectionState
Describes the current state of an existing Private Link Service connection to the Azure Private Endpoint.
provisioningState string
The provisioning state of the private link service connection. Valid values are Updating, Deleting, Failed, Succeeded, or Incomplete
group_id str
The group id from the provider of resource the private link service connection is for.
private_endpoint PrivateEndpointConnectionPropertiesResponsePrivateEndpoint
The private endpoint resource from Microsoft.Network provider.
private_link_service_connection_state PrivateEndpointConnectionPropertiesResponsePrivateLinkServiceConnectionState
Describes the current state of an existing Private Link Service connection to the Azure Private Endpoint.
provisioning_state str
The provisioning state of the private link service connection. Valid values are Updating, Deleting, Failed, Succeeded, or Incomplete
groupId String
The group id from the provider of resource the private link service connection is for.
privateEndpoint Property Map
The private endpoint resource from Microsoft.Network provider.
privateLinkServiceConnectionState Property Map
Describes the current state of an existing Private Link Service connection to the Azure Private Endpoint.
provisioningState String
The provisioning state of the private link service connection. Valid values are Updating, Deleting, Failed, Succeeded, or Incomplete

PrivateEndpointConnectionPropertiesResponsePrivateEndpoint
, PrivateEndpointConnectionPropertiesResponsePrivateEndpointArgs

Id string
The resource id of the private endpoint resource from Microsoft.Network provider.
Id string
The resource id of the private endpoint resource from Microsoft.Network provider.
id String
The resource id of the private endpoint resource from Microsoft.Network provider.
id string
The resource id of the private endpoint resource from Microsoft.Network provider.
id str
The resource id of the private endpoint resource from Microsoft.Network provider.
id String
The resource id of the private endpoint resource from Microsoft.Network provider.

PrivateEndpointConnectionPropertiesResponsePrivateLinkServiceConnectionState
, PrivateEndpointConnectionPropertiesResponsePrivateLinkServiceConnectionStateArgs

ActionsRequired string
A description of any extra actions that may be required.
Description string
The description for the private link service connection state.
Status string
Status of the the private link service connection. Valid values are Pending, Approved, Rejected, or Disconnected.
ActionsRequired string
A description of any extra actions that may be required.
Description string
The description for the private link service connection state.
Status string
Status of the the private link service connection. Valid values are Pending, Approved, Rejected, or Disconnected.
actionsRequired String
A description of any extra actions that may be required.
description String
The description for the private link service connection state.
status String
Status of the the private link service connection. Valid values are Pending, Approved, Rejected, or Disconnected.
actionsRequired string
A description of any extra actions that may be required.
description string
The description for the private link service connection state.
status string
Status of the the private link service connection. Valid values are Pending, Approved, Rejected, or Disconnected.
actions_required str
A description of any extra actions that may be required.
description str
The description for the private link service connection state.
status str
Status of the the private link service connection. Valid values are Pending, Approved, Rejected, or Disconnected.
actionsRequired String
A description of any extra actions that may be required.
description String
The description for the private link service connection state.
status String
Status of the the private link service connection. Valid values are Pending, Approved, Rejected, or Disconnected.

PrivateEndpointConnectionResponse
, PrivateEndpointConnectionResponseArgs

Id This property is required. string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Name This property is required. string
The name of the resource
Type This property is required. string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Properties Pulumi.AzureNative.Search.Inputs.PrivateEndpointConnectionPropertiesResponse
Describes the properties of an existing private endpoint connection to the search service.
Id This property is required. string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Name This property is required. string
The name of the resource
Type This property is required. string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Properties PrivateEndpointConnectionPropertiesResponse
Describes the properties of an existing private endpoint connection to the search service.
id This property is required. String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name This property is required. String
The name of the resource
type This property is required. String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
properties PrivateEndpointConnectionPropertiesResponse
Describes the properties of an existing private endpoint connection to the search service.
id This property is required. string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name This property is required. string
The name of the resource
type This property is required. string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
properties PrivateEndpointConnectionPropertiesResponse
Describes the properties of an existing private endpoint connection to the search service.
id This property is required. str
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name This property is required. str
The name of the resource
type This property is required. str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
properties PrivateEndpointConnectionPropertiesResponse
Describes the properties of an existing private endpoint connection to the search service.
id This property is required. String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name This property is required. String
The name of the resource
type This property is required. String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
properties Property Map
Describes the properties of an existing private endpoint connection to the search service.

PublicNetworkAccess
, PublicNetworkAccessArgs

Enabled
enabled
Disabled
disabled
PublicNetworkAccessEnabled
enabled
PublicNetworkAccessDisabled
disabled
Enabled
enabled
Disabled
disabled
Enabled
enabled
Disabled
disabled
ENABLED
enabled
DISABLED
disabled
"enabled"
enabled
"disabled"
disabled

SearchEncryptionWithCmk
, SearchEncryptionWithCmkArgs

Disabled
DisabledNo enforcement will be made and the search service can have non-customer-encrypted resources.
Enabled
EnabledSearch service will be marked as non-compliant if there are one or more non-customer-encrypted resources.
Unspecified
UnspecifiedEnforcement policy is not explicitly specified, with the behavior being the same as if it were set to 'Disabled'.
SearchEncryptionWithCmkDisabled
DisabledNo enforcement will be made and the search service can have non-customer-encrypted resources.
SearchEncryptionWithCmkEnabled
EnabledSearch service will be marked as non-compliant if there are one or more non-customer-encrypted resources.
SearchEncryptionWithCmkUnspecified
UnspecifiedEnforcement policy is not explicitly specified, with the behavior being the same as if it were set to 'Disabled'.
Disabled
DisabledNo enforcement will be made and the search service can have non-customer-encrypted resources.
Enabled
EnabledSearch service will be marked as non-compliant if there are one or more non-customer-encrypted resources.
Unspecified
UnspecifiedEnforcement policy is not explicitly specified, with the behavior being the same as if it were set to 'Disabled'.
Disabled
DisabledNo enforcement will be made and the search service can have non-customer-encrypted resources.
Enabled
EnabledSearch service will be marked as non-compliant if there are one or more non-customer-encrypted resources.
Unspecified
UnspecifiedEnforcement policy is not explicitly specified, with the behavior being the same as if it were set to 'Disabled'.
DISABLED
DisabledNo enforcement will be made and the search service can have non-customer-encrypted resources.
ENABLED
EnabledSearch service will be marked as non-compliant if there are one or more non-customer-encrypted resources.
UNSPECIFIED
UnspecifiedEnforcement policy is not explicitly specified, with the behavior being the same as if it were set to 'Disabled'.
"Disabled"
DisabledNo enforcement will be made and the search service can have non-customer-encrypted resources.
"Enabled"
EnabledSearch service will be marked as non-compliant if there are one or more non-customer-encrypted resources.
"Unspecified"
UnspecifiedEnforcement policy is not explicitly specified, with the behavior being the same as if it were set to 'Disabled'.

SearchSemanticSearch
, SearchSemanticSearchArgs

Disabled
disabledIndicates that semantic ranking is disabled for the search service.
Free
freeEnables semantic ranking on a search service and indicates that it is to be used within the limits of the free tier. This would cap the volume of semantic ranking requests and is offered at no extra charge. This is the default for newly provisioned search services.
Standard
standardEnables semantic ranking on a search service as a billable feature, with higher throughput and volume of semantic ranking requests.
SearchSemanticSearchDisabled
disabledIndicates that semantic ranking is disabled for the search service.
SearchSemanticSearchFree
freeEnables semantic ranking on a search service and indicates that it is to be used within the limits of the free tier. This would cap the volume of semantic ranking requests and is offered at no extra charge. This is the default for newly provisioned search services.
SearchSemanticSearchStandard
standardEnables semantic ranking on a search service as a billable feature, with higher throughput and volume of semantic ranking requests.
Disabled
disabledIndicates that semantic ranking is disabled for the search service.
Free
freeEnables semantic ranking on a search service and indicates that it is to be used within the limits of the free tier. This would cap the volume of semantic ranking requests and is offered at no extra charge. This is the default for newly provisioned search services.
Standard
standardEnables semantic ranking on a search service as a billable feature, with higher throughput and volume of semantic ranking requests.
Disabled
disabledIndicates that semantic ranking is disabled for the search service.
Free
freeEnables semantic ranking on a search service and indicates that it is to be used within the limits of the free tier. This would cap the volume of semantic ranking requests and is offered at no extra charge. This is the default for newly provisioned search services.
Standard
standardEnables semantic ranking on a search service as a billable feature, with higher throughput and volume of semantic ranking requests.
DISABLED
disabledIndicates that semantic ranking is disabled for the search service.
FREE
freeEnables semantic ranking on a search service and indicates that it is to be used within the limits of the free tier. This would cap the volume of semantic ranking requests and is offered at no extra charge. This is the default for newly provisioned search services.
STANDARD
standardEnables semantic ranking on a search service as a billable feature, with higher throughput and volume of semantic ranking requests.
"disabled"
disabledIndicates that semantic ranking is disabled for the search service.
"free"
freeEnables semantic ranking on a search service and indicates that it is to be used within the limits of the free tier. This would cap the volume of semantic ranking requests and is offered at no extra charge. This is the default for newly provisioned search services.
"standard"
standardEnables semantic ranking on a search service as a billable feature, with higher throughput and volume of semantic ranking requests.

SharedPrivateLinkResourcePropertiesResponse
, SharedPrivateLinkResourcePropertiesResponseArgs

GroupId string
The group id from the provider of resource the shared private link resource is for.
PrivateLinkResourceId string
The resource id of the resource the shared private link resource is for.
ProvisioningState string
The provisioning state of the shared private link resource. Valid values are Updating, Deleting, Failed, Succeeded or Incomplete.
RequestMessage string
The request message for requesting approval of the shared private link resource.
ResourceRegion string
Optional. Can be used to specify the Azure Resource Manager location of the resource to which a shared private link is to be created. This is only required for those resources whose DNS configuration are regional (such as Azure Kubernetes Service).
Status string
Status of the shared private link resource. Valid values are Pending, Approved, Rejected or Disconnected.
GroupId string
The group id from the provider of resource the shared private link resource is for.
PrivateLinkResourceId string
The resource id of the resource the shared private link resource is for.
ProvisioningState string
The provisioning state of the shared private link resource. Valid values are Updating, Deleting, Failed, Succeeded or Incomplete.
RequestMessage string
The request message for requesting approval of the shared private link resource.
ResourceRegion string
Optional. Can be used to specify the Azure Resource Manager location of the resource to which a shared private link is to be created. This is only required for those resources whose DNS configuration are regional (such as Azure Kubernetes Service).
Status string
Status of the shared private link resource. Valid values are Pending, Approved, Rejected or Disconnected.
groupId String
The group id from the provider of resource the shared private link resource is for.
privateLinkResourceId String
The resource id of the resource the shared private link resource is for.
provisioningState String
The provisioning state of the shared private link resource. Valid values are Updating, Deleting, Failed, Succeeded or Incomplete.
requestMessage String
The request message for requesting approval of the shared private link resource.
resourceRegion String
Optional. Can be used to specify the Azure Resource Manager location of the resource to which a shared private link is to be created. This is only required for those resources whose DNS configuration are regional (such as Azure Kubernetes Service).
status String
Status of the shared private link resource. Valid values are Pending, Approved, Rejected or Disconnected.
groupId string
The group id from the provider of resource the shared private link resource is for.
privateLinkResourceId string
The resource id of the resource the shared private link resource is for.
provisioningState string
The provisioning state of the shared private link resource. Valid values are Updating, Deleting, Failed, Succeeded or Incomplete.
requestMessage string
The request message for requesting approval of the shared private link resource.
resourceRegion string
Optional. Can be used to specify the Azure Resource Manager location of the resource to which a shared private link is to be created. This is only required for those resources whose DNS configuration are regional (such as Azure Kubernetes Service).
status string
Status of the shared private link resource. Valid values are Pending, Approved, Rejected or Disconnected.
group_id str
The group id from the provider of resource the shared private link resource is for.
private_link_resource_id str
The resource id of the resource the shared private link resource is for.
provisioning_state str
The provisioning state of the shared private link resource. Valid values are Updating, Deleting, Failed, Succeeded or Incomplete.
request_message str
The request message for requesting approval of the shared private link resource.
resource_region str
Optional. Can be used to specify the Azure Resource Manager location of the resource to which a shared private link is to be created. This is only required for those resources whose DNS configuration are regional (such as Azure Kubernetes Service).
status str
Status of the shared private link resource. Valid values are Pending, Approved, Rejected or Disconnected.
groupId String
The group id from the provider of resource the shared private link resource is for.
privateLinkResourceId String
The resource id of the resource the shared private link resource is for.
provisioningState String
The provisioning state of the shared private link resource. Valid values are Updating, Deleting, Failed, Succeeded or Incomplete.
requestMessage String
The request message for requesting approval of the shared private link resource.
resourceRegion String
Optional. Can be used to specify the Azure Resource Manager location of the resource to which a shared private link is to be created. This is only required for those resources whose DNS configuration are regional (such as Azure Kubernetes Service).
status String
Status of the shared private link resource. Valid values are Pending, Approved, Rejected or Disconnected.

SharedPrivateLinkResourceResponse
, SharedPrivateLinkResourceResponseArgs

Id This property is required. string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Name This property is required. string
The name of the resource
Type This property is required. string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Properties Pulumi.AzureNative.Search.Inputs.SharedPrivateLinkResourcePropertiesResponse
Describes the properties of a Shared Private Link Resource managed by the search service.
Id This property is required. string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Name This property is required. string
The name of the resource
Type This property is required. string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Properties SharedPrivateLinkResourcePropertiesResponse
Describes the properties of a Shared Private Link Resource managed by the search service.
id This property is required. String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name This property is required. String
The name of the resource
type This property is required. String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
properties SharedPrivateLinkResourcePropertiesResponse
Describes the properties of a Shared Private Link Resource managed by the search service.
id This property is required. string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name This property is required. string
The name of the resource
type This property is required. string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
properties SharedPrivateLinkResourcePropertiesResponse
Describes the properties of a Shared Private Link Resource managed by the search service.
id This property is required. str
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name This property is required. str
The name of the resource
type This property is required. str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
properties SharedPrivateLinkResourcePropertiesResponse
Describes the properties of a Shared Private Link Resource managed by the search service.
id This property is required. String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name This property is required. String
The name of the resource
type This property is required. String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
properties Property Map
Describes the properties of a Shared Private Link Resource managed by the search service.

Sku
, SkuArgs

Name Pulumi.AzureNative.Search.SkuName
The SKU of the search service. Valid values include: 'free': Shared service. 'basic': Dedicated service with up to 3 replicas. 'standard': Dedicated service with up to 12 partitions and 12 replicas. 'standard2': Similar to standard, but with more capacity per search unit. 'standard3': The largest Standard offering with up to 12 partitions and 12 replicas (or up to 3 partitions with more indexes if you also set the hostingMode property to 'highDensity'). 'storage_optimized_l1': Supports 1TB per partition, up to 12 partitions. 'storage_optimized_l2': Supports 2TB per partition, up to 12 partitions.'
Name SkuName
The SKU of the search service. Valid values include: 'free': Shared service. 'basic': Dedicated service with up to 3 replicas. 'standard': Dedicated service with up to 12 partitions and 12 replicas. 'standard2': Similar to standard, but with more capacity per search unit. 'standard3': The largest Standard offering with up to 12 partitions and 12 replicas (or up to 3 partitions with more indexes if you also set the hostingMode property to 'highDensity'). 'storage_optimized_l1': Supports 1TB per partition, up to 12 partitions. 'storage_optimized_l2': Supports 2TB per partition, up to 12 partitions.'
name SkuName
The SKU of the search service. Valid values include: 'free': Shared service. 'basic': Dedicated service with up to 3 replicas. 'standard': Dedicated service with up to 12 partitions and 12 replicas. 'standard2': Similar to standard, but with more capacity per search unit. 'standard3': The largest Standard offering with up to 12 partitions and 12 replicas (or up to 3 partitions with more indexes if you also set the hostingMode property to 'highDensity'). 'storage_optimized_l1': Supports 1TB per partition, up to 12 partitions. 'storage_optimized_l2': Supports 2TB per partition, up to 12 partitions.'
name SkuName
The SKU of the search service. Valid values include: 'free': Shared service. 'basic': Dedicated service with up to 3 replicas. 'standard': Dedicated service with up to 12 partitions and 12 replicas. 'standard2': Similar to standard, but with more capacity per search unit. 'standard3': The largest Standard offering with up to 12 partitions and 12 replicas (or up to 3 partitions with more indexes if you also set the hostingMode property to 'highDensity'). 'storage_optimized_l1': Supports 1TB per partition, up to 12 partitions. 'storage_optimized_l2': Supports 2TB per partition, up to 12 partitions.'
name SkuName
The SKU of the search service. Valid values include: 'free': Shared service. 'basic': Dedicated service with up to 3 replicas. 'standard': Dedicated service with up to 12 partitions and 12 replicas. 'standard2': Similar to standard, but with more capacity per search unit. 'standard3': The largest Standard offering with up to 12 partitions and 12 replicas (or up to 3 partitions with more indexes if you also set the hostingMode property to 'highDensity'). 'storage_optimized_l1': Supports 1TB per partition, up to 12 partitions. 'storage_optimized_l2': Supports 2TB per partition, up to 12 partitions.'
name "free" | "basic" | "standard" | "standard2" | "standard3" | "storage_optimized_l1" | "storage_optimized_l2"
The SKU of the search service. Valid values include: 'free': Shared service. 'basic': Dedicated service with up to 3 replicas. 'standard': Dedicated service with up to 12 partitions and 12 replicas. 'standard2': Similar to standard, but with more capacity per search unit. 'standard3': The largest Standard offering with up to 12 partitions and 12 replicas (or up to 3 partitions with more indexes if you also set the hostingMode property to 'highDensity'). 'storage_optimized_l1': Supports 1TB per partition, up to 12 partitions. 'storage_optimized_l2': Supports 2TB per partition, up to 12 partitions.'

SkuName
, SkuNameArgs

Free
freeFree tier, with no SLA guarantees and a subset of the features offered on billable tiers.
Basic
basicBillable tier for a dedicated service having up to 3 replicas.
Standard
standardBillable tier for a dedicated service having up to 12 partitions and 12 replicas.
Standard2
standard2Similar to 'standard', but with more capacity per search unit.
Standard3
standard3The largest Standard offering with up to 12 partitions and 12 replicas (or up to 3 partitions with more indexes if you also set the hostingMode property to 'highDensity').
StorageOptimizedL1
storage_optimized_l1Billable tier for a dedicated service that supports 1TB per partition, up to 12 partitions.
StorageOptimizedL2
storage_optimized_l2Billable tier for a dedicated service that supports 2TB per partition, up to 12 partitions.
SkuNameFree
freeFree tier, with no SLA guarantees and a subset of the features offered on billable tiers.
SkuNameBasic
basicBillable tier for a dedicated service having up to 3 replicas.
SkuNameStandard
standardBillable tier for a dedicated service having up to 12 partitions and 12 replicas.
SkuNameStandard2
standard2Similar to 'standard', but with more capacity per search unit.
SkuNameStandard3
standard3The largest Standard offering with up to 12 partitions and 12 replicas (or up to 3 partitions with more indexes if you also set the hostingMode property to 'highDensity').
SkuNameStorageOptimizedL1
storage_optimized_l1Billable tier for a dedicated service that supports 1TB per partition, up to 12 partitions.
SkuNameStorageOptimizedL2
storage_optimized_l2Billable tier for a dedicated service that supports 2TB per partition, up to 12 partitions.
Free
freeFree tier, with no SLA guarantees and a subset of the features offered on billable tiers.
Basic
basicBillable tier for a dedicated service having up to 3 replicas.
Standard
standardBillable tier for a dedicated service having up to 12 partitions and 12 replicas.
Standard2
standard2Similar to 'standard', but with more capacity per search unit.
Standard3
standard3The largest Standard offering with up to 12 partitions and 12 replicas (or up to 3 partitions with more indexes if you also set the hostingMode property to 'highDensity').
StorageOptimizedL1
storage_optimized_l1Billable tier for a dedicated service that supports 1TB per partition, up to 12 partitions.
StorageOptimizedL2
storage_optimized_l2Billable tier for a dedicated service that supports 2TB per partition, up to 12 partitions.
Free
freeFree tier, with no SLA guarantees and a subset of the features offered on billable tiers.
Basic
basicBillable tier for a dedicated service having up to 3 replicas.
Standard
standardBillable tier for a dedicated service having up to 12 partitions and 12 replicas.
Standard2
standard2Similar to 'standard', but with more capacity per search unit.
Standard3
standard3The largest Standard offering with up to 12 partitions and 12 replicas (or up to 3 partitions with more indexes if you also set the hostingMode property to 'highDensity').
StorageOptimizedL1
storage_optimized_l1Billable tier for a dedicated service that supports 1TB per partition, up to 12 partitions.
StorageOptimizedL2
storage_optimized_l2Billable tier for a dedicated service that supports 2TB per partition, up to 12 partitions.
FREE
freeFree tier, with no SLA guarantees and a subset of the features offered on billable tiers.
BASIC
basicBillable tier for a dedicated service having up to 3 replicas.
STANDARD
standardBillable tier for a dedicated service having up to 12 partitions and 12 replicas.
STANDARD2
standard2Similar to 'standard', but with more capacity per search unit.
STANDARD3
standard3The largest Standard offering with up to 12 partitions and 12 replicas (or up to 3 partitions with more indexes if you also set the hostingMode property to 'highDensity').
STORAGE_OPTIMIZED_L1
storage_optimized_l1Billable tier for a dedicated service that supports 1TB per partition, up to 12 partitions.
STORAGE_OPTIMIZED_L2
storage_optimized_l2Billable tier for a dedicated service that supports 2TB per partition, up to 12 partitions.
"free"
freeFree tier, with no SLA guarantees and a subset of the features offered on billable tiers.
"basic"
basicBillable tier for a dedicated service having up to 3 replicas.
"standard"
standardBillable tier for a dedicated service having up to 12 partitions and 12 replicas.
"standard2"
standard2Similar to 'standard', but with more capacity per search unit.
"standard3"
standard3The largest Standard offering with up to 12 partitions and 12 replicas (or up to 3 partitions with more indexes if you also set the hostingMode property to 'highDensity').
"storage_optimized_l1"
storage_optimized_l1Billable tier for a dedicated service that supports 1TB per partition, up to 12 partitions.
"storage_optimized_l2"
storage_optimized_l2Billable tier for a dedicated service that supports 2TB per partition, up to 12 partitions.

SkuResponse
, SkuResponseArgs

Name string
The SKU of the search service. Valid values include: 'free': Shared service. 'basic': Dedicated service with up to 3 replicas. 'standard': Dedicated service with up to 12 partitions and 12 replicas. 'standard2': Similar to standard, but with more capacity per search unit. 'standard3': The largest Standard offering with up to 12 partitions and 12 replicas (or up to 3 partitions with more indexes if you also set the hostingMode property to 'highDensity'). 'storage_optimized_l1': Supports 1TB per partition, up to 12 partitions. 'storage_optimized_l2': Supports 2TB per partition, up to 12 partitions.'
Name string
The SKU of the search service. Valid values include: 'free': Shared service. 'basic': Dedicated service with up to 3 replicas. 'standard': Dedicated service with up to 12 partitions and 12 replicas. 'standard2': Similar to standard, but with more capacity per search unit. 'standard3': The largest Standard offering with up to 12 partitions and 12 replicas (or up to 3 partitions with more indexes if you also set the hostingMode property to 'highDensity'). 'storage_optimized_l1': Supports 1TB per partition, up to 12 partitions. 'storage_optimized_l2': Supports 2TB per partition, up to 12 partitions.'
name String
The SKU of the search service. Valid values include: 'free': Shared service. 'basic': Dedicated service with up to 3 replicas. 'standard': Dedicated service with up to 12 partitions and 12 replicas. 'standard2': Similar to standard, but with more capacity per search unit. 'standard3': The largest Standard offering with up to 12 partitions and 12 replicas (or up to 3 partitions with more indexes if you also set the hostingMode property to 'highDensity'). 'storage_optimized_l1': Supports 1TB per partition, up to 12 partitions. 'storage_optimized_l2': Supports 2TB per partition, up to 12 partitions.'
name string
The SKU of the search service. Valid values include: 'free': Shared service. 'basic': Dedicated service with up to 3 replicas. 'standard': Dedicated service with up to 12 partitions and 12 replicas. 'standard2': Similar to standard, but with more capacity per search unit. 'standard3': The largest Standard offering with up to 12 partitions and 12 replicas (or up to 3 partitions with more indexes if you also set the hostingMode property to 'highDensity'). 'storage_optimized_l1': Supports 1TB per partition, up to 12 partitions. 'storage_optimized_l2': Supports 2TB per partition, up to 12 partitions.'
name str
The SKU of the search service. Valid values include: 'free': Shared service. 'basic': Dedicated service with up to 3 replicas. 'standard': Dedicated service with up to 12 partitions and 12 replicas. 'standard2': Similar to standard, but with more capacity per search unit. 'standard3': The largest Standard offering with up to 12 partitions and 12 replicas (or up to 3 partitions with more indexes if you also set the hostingMode property to 'highDensity'). 'storage_optimized_l1': Supports 1TB per partition, up to 12 partitions. 'storage_optimized_l2': Supports 2TB per partition, up to 12 partitions.'
name String
The SKU of the search service. Valid values include: 'free': Shared service. 'basic': Dedicated service with up to 3 replicas. 'standard': Dedicated service with up to 12 partitions and 12 replicas. 'standard2': Similar to standard, but with more capacity per search unit. 'standard3': The largest Standard offering with up to 12 partitions and 12 replicas (or up to 3 partitions with more indexes if you also set the hostingMode property to 'highDensity'). 'storage_optimized_l1': Supports 1TB per partition, up to 12 partitions. 'storage_optimized_l2': Supports 2TB per partition, up to 12 partitions.'

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:search:Service mysearchservice /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}
Copy

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

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native