import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * Manages a Search Service. * * ## Example Usage * * ### Supporting API Keys) * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as azure from "@pulumi/azure"; * * const example = new azure.core.ResourceGroup("example", { * name: "example-resources", * location: "West Europe", * }); * const exampleService = new azure.search.Service("example", { * name: "example-resource", * resourceGroupName: example.name, * location: example.location, * sku: "standard", * }); * ``` * * ### Using Both AzureAD And API Keys) * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as azure from "@pulumi/azure"; * * const example = new azure.core.ResourceGroup("example", { * name: "example-resources", * location: "West Europe", * }); * const exampleService = new azure.search.Service("example", { * name: "example-resource", * resourceGroupName: example.name, * location: example.location, * sku: "standard", * localAuthenticationEnabled: true, * authenticationFailureMode: "http403", * }); * ``` * * ### Supporting Only AzureAD Authentication) * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as azure from "@pulumi/azure"; * * const example = new azure.core.ResourceGroup("example", { * name: "example-resources", * location: "West Europe", * }); * const exampleService = new azure.search.Service("example", { * name: "example-resource", * resourceGroupName: example.name, * location: example.location, * sku: "standard", * localAuthenticationEnabled: false, * }); * ``` * * ## API Providers * * * This resource uses the following Azure API Providers: * * * `Microsoft.Search` - 2025-05-01 * * ## Import * * Search Services can be imported using the `resource id`, e.g. * * ```sh * $ pulumi import azure:search/service:Service example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.Search/searchServices/service1 * ``` */ export declare class Service extends pulumi.CustomResource { /** * Get an existing Service resource's state with the given name, ID, and optional extra * properties used to qualify the lookup. * * @param name The _unique_ name of the resulting resource. * @param id The _unique_ provider ID of the resource to lookup. * @param state Any extra arguments used during the lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input, state?: ServiceState, opts?: pulumi.CustomResourceOptions): Service; /** * Returns true if the given object is an instance of Service. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is Service; /** * Specifies a list of inbound IPv4 or CIDRs that are allowed to access the Search Service. If the incoming IP request is from an IP address which is not included in the `allowedIps` it will be blocked by the Search Services firewall. * * > **Note:** The `allowedIps` are only applied if the `publicNetworkAccessEnabled` field has been set to `true`, else all traffic over the public interface will be rejected, even if the `allowedIps` field has been defined. When the `publicNetworkAccessEnabled` field has been set to `false` the private endpoint connections are the only allowed access point to the Search Service. */ readonly allowedIps: pulumi.Output; /** * Specifies the response that the Search Service should return for requests that fail authentication. Possible values include `http401WithBearerChallenge` or `http403`. * * > **Note:** `authenticationFailureMode` can only be configured when using `localAuthenticationEnabled` is set to `true` - which when set together specifies that both API Keys and AzureAD Authentication should be supported. */ readonly authenticationFailureMode: pulumi.Output; /** * 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`. If all the resources are customer encrypted, then the service will be marked as `Compliant`. */ readonly customerManagedKeyEncryptionComplianceStatus: pulumi.Output; /** * Specifies whether the Search Service should enforce that non-customer resources are encrypted. Defaults to `false`. */ readonly customerManagedKeyEnforcementEnabled: pulumi.Output; /** * The endpoint used to connect to this Search Service. */ readonly endpoint: pulumi.Output; /** * Specifies the Hosting Mode, which allows for High Density partitions (that allow for up to 1000 indexes) should be supported. Possible values are `HighDensity` or `Default`. Defaults to `Default`. Changing this forces a new Search Service to be created. * * > **Note:** `hostingMode` can only be configured when `sku` is set to `standard3`. */ readonly hostingMode: pulumi.Output; /** * An `identity` block as defined below. */ readonly identity: pulumi.Output; /** * Specifies whether the Search Service allows authenticating using API Keys? Defaults to `true`. */ readonly localAuthenticationEnabled: pulumi.Output; /** * The Azure Region where the Search Service should exist. Changing this forces a new Search Service to be created. */ readonly location: pulumi.Output; /** * The Name which should be used for this Search Service. Changing this forces a new Search Service to be created. */ readonly name: pulumi.Output; /** * Whether to allow trusted Azure services to access a network restricted Search Service? Possible values are `None` and `AzureServices`. Defaults to `None`. */ readonly networkRuleBypassOption: pulumi.Output; /** * Specifies the number of partitions which should be created. This field cannot be set when using a `free` sku ([see the Microsoft documentation](https://learn.microsoft.com/azure/search/search-sku-tier)). Possible values include `1`, `2`, `3`, `4`, `6`, or `12`. Defaults to `1`. * * > **Note:** when `hostingMode` is set to `highDensity` the maximum number of partitions allowed is `3`. */ readonly partitionCount: pulumi.Output; /** * The Primary Key used for Search Service Administration. */ readonly primaryKey: pulumi.Output; /** * Specifies whether Public Network Access is allowed for this resource. Defaults to `true`. */ readonly publicNetworkAccessEnabled: pulumi.Output; /** * A `queryKeys` block as defined below. */ readonly queryKeys: pulumi.Output; /** * Specifies the number of Replica's which should be created for this Search Service. This field cannot be set when using a `free` sku ([see the Microsoft documentation](https://learn.microsoft.com/azure/search/search-sku-tier)). */ readonly replicaCount: pulumi.Output; /** * The name of the Resource Group where the Search Service should exist. Changing this forces a new Search Service to be created. */ readonly resourceGroupName: pulumi.Output; /** * The Secondary Key used for Search Service Administration. */ readonly secondaryKey: pulumi.Output; /** * Specifies the Semantic Search SKU which should be used for this Search Service. Possible values include `free` and `standard`. * * > **Note:** The `semanticSearchSku` cannot be defined if your Search Services `sku` is set to `free`. The Semantic Search feature is only available in certain regions, please see the [product documentation](https://learn.microsoft.com/azure/search/semantic-search-overview#availability-and-pricing) for more information. */ readonly semanticSearchSku: pulumi.Output; /** * The SKU which should be used for this Search Service. Possible values include `basic`, `free`, `standard`, `standard2`, `standard3`, `storageOptimizedL1` and `storageOptimizedL2`. * * > **Note:** The `basic` and `free` SKUs provision the Search Service in a Shared Cluster - the `standard` SKUs use a Dedicated Cluster. * * > **Note:** The SKUs `standard2`, `standard3`, `storageOptimizedL1` and `storageOptimizedL2` are only available by submitting a quota increase request to Microsoft. Please see the [product documentation](https://learn.microsoft.com/azure/azure-resource-manager/troubleshooting/error-resource-quota?tabs=azure-cli) on how to submit a quota increase request. * * > **Note:** SKU upgrades between Basic and Standard (S1, S2, S3) tiers from a lower tier to a higher tier (e.g., Basic → S1, S1 → S2, S2 → S3) are supported without recreating the resource. And your region must support the higher tier. All other SKU changes (downgrades, changes from/to Free tier, or changes to/from Storage Optimized tiers) will force creation of a new Search Service. */ readonly sku: pulumi.Output; /** * Specifies a mapping of tags which should be assigned to this Search Service. */ readonly tags: pulumi.Output<{ [key: string]: string; } | undefined>; /** * Create a Service resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args: ServiceArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering Service resources. */ export interface ServiceState { /** * Specifies a list of inbound IPv4 or CIDRs that are allowed to access the Search Service. If the incoming IP request is from an IP address which is not included in the `allowedIps` it will be blocked by the Search Services firewall. * * > **Note:** The `allowedIps` are only applied if the `publicNetworkAccessEnabled` field has been set to `true`, else all traffic over the public interface will be rejected, even if the `allowedIps` field has been defined. When the `publicNetworkAccessEnabled` field has been set to `false` the private endpoint connections are the only allowed access point to the Search Service. */ allowedIps?: pulumi.Input[]>; /** * Specifies the response that the Search Service should return for requests that fail authentication. Possible values include `http401WithBearerChallenge` or `http403`. * * > **Note:** `authenticationFailureMode` can only be configured when using `localAuthenticationEnabled` is set to `true` - which when set together specifies that both API Keys and AzureAD Authentication should be supported. */ authenticationFailureMode?: pulumi.Input; /** * 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`. If all the resources are customer encrypted, then the service will be marked as `Compliant`. */ customerManagedKeyEncryptionComplianceStatus?: pulumi.Input; /** * Specifies whether the Search Service should enforce that non-customer resources are encrypted. Defaults to `false`. */ customerManagedKeyEnforcementEnabled?: pulumi.Input; /** * The endpoint used to connect to this Search Service. */ endpoint?: pulumi.Input; /** * Specifies the Hosting Mode, which allows for High Density partitions (that allow for up to 1000 indexes) should be supported. Possible values are `HighDensity` or `Default`. Defaults to `Default`. Changing this forces a new Search Service to be created. * * > **Note:** `hostingMode` can only be configured when `sku` is set to `standard3`. */ hostingMode?: pulumi.Input; /** * An `identity` block as defined below. */ identity?: pulumi.Input; /** * Specifies whether the Search Service allows authenticating using API Keys? Defaults to `true`. */ localAuthenticationEnabled?: pulumi.Input; /** * The Azure Region where the Search Service should exist. Changing this forces a new Search Service to be created. */ location?: pulumi.Input; /** * The Name which should be used for this Search Service. Changing this forces a new Search Service to be created. */ name?: pulumi.Input; /** * Whether to allow trusted Azure services to access a network restricted Search Service? Possible values are `None` and `AzureServices`. Defaults to `None`. */ networkRuleBypassOption?: pulumi.Input; /** * Specifies the number of partitions which should be created. This field cannot be set when using a `free` sku ([see the Microsoft documentation](https://learn.microsoft.com/azure/search/search-sku-tier)). Possible values include `1`, `2`, `3`, `4`, `6`, or `12`. Defaults to `1`. * * > **Note:** when `hostingMode` is set to `highDensity` the maximum number of partitions allowed is `3`. */ partitionCount?: pulumi.Input; /** * The Primary Key used for Search Service Administration. */ primaryKey?: pulumi.Input; /** * Specifies whether Public Network Access is allowed for this resource. Defaults to `true`. */ publicNetworkAccessEnabled?: pulumi.Input; /** * A `queryKeys` block as defined below. */ queryKeys?: pulumi.Input[]>; /** * Specifies the number of Replica's which should be created for this Search Service. This field cannot be set when using a `free` sku ([see the Microsoft documentation](https://learn.microsoft.com/azure/search/search-sku-tier)). */ replicaCount?: pulumi.Input; /** * The name of the Resource Group where the Search Service should exist. Changing this forces a new Search Service to be created. */ resourceGroupName?: pulumi.Input; /** * The Secondary Key used for Search Service Administration. */ secondaryKey?: pulumi.Input; /** * Specifies the Semantic Search SKU which should be used for this Search Service. Possible values include `free` and `standard`. * * > **Note:** The `semanticSearchSku` cannot be defined if your Search Services `sku` is set to `free`. The Semantic Search feature is only available in certain regions, please see the [product documentation](https://learn.microsoft.com/azure/search/semantic-search-overview#availability-and-pricing) for more information. */ semanticSearchSku?: pulumi.Input; /** * The SKU which should be used for this Search Service. Possible values include `basic`, `free`, `standard`, `standard2`, `standard3`, `storageOptimizedL1` and `storageOptimizedL2`. * * > **Note:** The `basic` and `free` SKUs provision the Search Service in a Shared Cluster - the `standard` SKUs use a Dedicated Cluster. * * > **Note:** The SKUs `standard2`, `standard3`, `storageOptimizedL1` and `storageOptimizedL2` are only available by submitting a quota increase request to Microsoft. Please see the [product documentation](https://learn.microsoft.com/azure/azure-resource-manager/troubleshooting/error-resource-quota?tabs=azure-cli) on how to submit a quota increase request. * * > **Note:** SKU upgrades between Basic and Standard (S1, S2, S3) tiers from a lower tier to a higher tier (e.g., Basic → S1, S1 → S2, S2 → S3) are supported without recreating the resource. And your region must support the higher tier. All other SKU changes (downgrades, changes from/to Free tier, or changes to/from Storage Optimized tiers) will force creation of a new Search Service. */ sku?: pulumi.Input; /** * Specifies a mapping of tags which should be assigned to this Search Service. */ tags?: pulumi.Input<{ [key: string]: pulumi.Input; }>; } /** * The set of arguments for constructing a Service resource. */ export interface ServiceArgs { /** * Specifies a list of inbound IPv4 or CIDRs that are allowed to access the Search Service. If the incoming IP request is from an IP address which is not included in the `allowedIps` it will be blocked by the Search Services firewall. * * > **Note:** The `allowedIps` are only applied if the `publicNetworkAccessEnabled` field has been set to `true`, else all traffic over the public interface will be rejected, even if the `allowedIps` field has been defined. When the `publicNetworkAccessEnabled` field has been set to `false` the private endpoint connections are the only allowed access point to the Search Service. */ allowedIps?: pulumi.Input[]>; /** * Specifies the response that the Search Service should return for requests that fail authentication. Possible values include `http401WithBearerChallenge` or `http403`. * * > **Note:** `authenticationFailureMode` can only be configured when using `localAuthenticationEnabled` is set to `true` - which when set together specifies that both API Keys and AzureAD Authentication should be supported. */ authenticationFailureMode?: pulumi.Input; /** * Specifies whether the Search Service should enforce that non-customer resources are encrypted. Defaults to `false`. */ customerManagedKeyEnforcementEnabled?: pulumi.Input; /** * Specifies the Hosting Mode, which allows for High Density partitions (that allow for up to 1000 indexes) should be supported. Possible values are `HighDensity` or `Default`. Defaults to `Default`. Changing this forces a new Search Service to be created. * * > **Note:** `hostingMode` can only be configured when `sku` is set to `standard3`. */ hostingMode?: pulumi.Input; /** * An `identity` block as defined below. */ identity?: pulumi.Input; /** * Specifies whether the Search Service allows authenticating using API Keys? Defaults to `true`. */ localAuthenticationEnabled?: pulumi.Input; /** * The Azure Region where the Search Service should exist. Changing this forces a new Search Service to be created. */ location?: pulumi.Input; /** * The Name which should be used for this Search Service. Changing this forces a new Search Service to be created. */ name?: pulumi.Input; /** * Whether to allow trusted Azure services to access a network restricted Search Service? Possible values are `None` and `AzureServices`. Defaults to `None`. */ networkRuleBypassOption?: pulumi.Input; /** * Specifies the number of partitions which should be created. This field cannot be set when using a `free` sku ([see the Microsoft documentation](https://learn.microsoft.com/azure/search/search-sku-tier)). Possible values include `1`, `2`, `3`, `4`, `6`, or `12`. Defaults to `1`. * * > **Note:** when `hostingMode` is set to `highDensity` the maximum number of partitions allowed is `3`. */ partitionCount?: pulumi.Input; /** * Specifies whether Public Network Access is allowed for this resource. Defaults to `true`. */ publicNetworkAccessEnabled?: pulumi.Input; /** * Specifies the number of Replica's which should be created for this Search Service. This field cannot be set when using a `free` sku ([see the Microsoft documentation](https://learn.microsoft.com/azure/search/search-sku-tier)). */ replicaCount?: pulumi.Input; /** * The name of the Resource Group where the Search Service should exist. Changing this forces a new Search Service to be created. */ resourceGroupName: pulumi.Input; /** * Specifies the Semantic Search SKU which should be used for this Search Service. Possible values include `free` and `standard`. * * > **Note:** The `semanticSearchSku` cannot be defined if your Search Services `sku` is set to `free`. The Semantic Search feature is only available in certain regions, please see the [product documentation](https://learn.microsoft.com/azure/search/semantic-search-overview#availability-and-pricing) for more information. */ semanticSearchSku?: pulumi.Input; /** * The SKU which should be used for this Search Service. Possible values include `basic`, `free`, `standard`, `standard2`, `standard3`, `storageOptimizedL1` and `storageOptimizedL2`. * * > **Note:** The `basic` and `free` SKUs provision the Search Service in a Shared Cluster - the `standard` SKUs use a Dedicated Cluster. * * > **Note:** The SKUs `standard2`, `standard3`, `storageOptimizedL1` and `storageOptimizedL2` are only available by submitting a quota increase request to Microsoft. Please see the [product documentation](https://learn.microsoft.com/azure/azure-resource-manager/troubleshooting/error-resource-quota?tabs=azure-cli) on how to submit a quota increase request. * * > **Note:** SKU upgrades between Basic and Standard (S1, S2, S3) tiers from a lower tier to a higher tier (e.g., Basic → S1, S1 → S2, S2 → S3) are supported without recreating the resource. And your region must support the higher tier. All other SKU changes (downgrades, changes from/to Free tier, or changes to/from Storage Optimized tiers) will force creation of a new Search Service. */ sku: pulumi.Input; /** * Specifies a mapping of tags which should be assigned to this Search Service. */ tags?: pulumi.Input<{ [key: string]: pulumi.Input; }>; }