azure.search.Service
Manages a Search Service.
Example Usage
using System.Collections.Generic;
using Pulumi;
using Azure = Pulumi.Azure;
return await Deployment.RunAsync(() =>
{
var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new()
{
Location = "West Europe",
});
var exampleService = new Azure.Search.Service("exampleService", new()
{
ResourceGroupName = exampleResourceGroup.Name,
Location = exampleResourceGroup.Location,
Sku = "standard",
});
});
package main
import (
"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/search"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
Location: pulumi.String("West Europe"),
})
if err != nil {
return err
}
_, err = search.NewService(ctx, "exampleService", &search.ServiceArgs{
ResourceGroupName: exampleResourceGroup.Name,
Location: exampleResourceGroup.Location,
Sku: pulumi.String("standard"),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.search.Service;
import com.pulumi.azure.search.ServiceArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()
.location("West Europe")
.build());
var exampleService = new Service("exampleService", ServiceArgs.builder()
.resourceGroupName(exampleResourceGroup.name())
.location(exampleResourceGroup.location())
.sku("standard")
.build());
}
}
import pulumi
import pulumi_azure as azure
example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_service = azure.search.Service("exampleService",
resource_group_name=example_resource_group.name,
location=example_resource_group.location,
sku="standard")
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleService = new azure.search.Service("exampleService", {
resourceGroupName: exampleResourceGroup.name,
location: exampleResourceGroup.location,
sku: "standard",
});
resources:
exampleResourceGroup:
type: azure:core:ResourceGroup
properties:
location: West Europe
exampleService:
type: azure:search:Service
properties:
resourceGroupName: ${exampleResourceGroup.name}
location: ${exampleResourceGroup.location}
sku: standard
Create Service Resource
new Service(name: string, args: ServiceArgs, opts?: CustomResourceOptions);
@overload
def Service(resource_name: str,
opts: Optional[ResourceOptions] = None,
allowed_ips: Optional[Sequence[str]] = None,
identity: Optional[ServiceIdentityArgs] = None,
location: Optional[str] = None,
name: Optional[str] = None,
partition_count: Optional[int] = None,
public_network_access_enabled: Optional[bool] = None,
replica_count: Optional[int] = None,
resource_group_name: Optional[str] = None,
sku: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None)
@overload
def Service(resource_name: str,
args: ServiceArgs,
opts: Optional[ResourceOptions] = None)
func NewService(ctx *Context, name string, args ServiceArgs, opts ...ResourceOption) (*Service, error)
public Service(string name, ServiceArgs args, CustomResourceOptions? opts = null)
public Service(String name, ServiceArgs args)
public Service(String name, ServiceArgs args, CustomResourceOptions options)
type: azure:search:Service
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ServiceArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args ServiceArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args ServiceArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ServiceArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ServiceArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
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
The Service resource accepts the following input properties:
- Resource
Group stringName The name of the Resource Group where the Search Service should exist. Changing this forces a new Search Service to be created.
- Sku string
The SKU which should be used for this Search Service. Possible values are
basic
,free
,standard
,standard2
,standard3
,storage_optimized_l1
andstorage_optimized_l2
. Changing this forces a new Search Service to be created.- Allowed
Ips List<string> A list of IPv4 addresses or CIDRs that are allowed access to the search service endpoint.
- Identity
Service
Identity Args An
identity
block as defined below.- Location string
The Azure Region where the Search Service should exist. Changing this forces a new Search Service to be created.
- Name string
The Name which should be used for this Search Service. Changing this forces a new Search Service to be created.
- Partition
Count int The number of partitions which should be created.
- Public
Network boolAccess Enabled Whether or not public network access is allowed for this resource. Defaults to
true
.- Replica
Count int The number of replica's which should be created.
- Dictionary<string, string>
A mapping of tags which should be assigned to the Search Service.
- Resource
Group stringName The name of the Resource Group where the Search Service should exist. Changing this forces a new Search Service to be created.
- Sku string
The SKU which should be used for this Search Service. Possible values are
basic
,free
,standard
,standard2
,standard3
,storage_optimized_l1
andstorage_optimized_l2
. Changing this forces a new Search Service to be created.- Allowed
Ips []string A list of IPv4 addresses or CIDRs that are allowed access to the search service endpoint.
- Identity
Service
Identity Args An
identity
block as defined below.- Location string
The Azure Region where the Search Service should exist. Changing this forces a new Search Service to be created.
- Name string
The Name which should be used for this Search Service. Changing this forces a new Search Service to be created.
- Partition
Count int The number of partitions which should be created.
- Public
Network boolAccess Enabled Whether or not public network access is allowed for this resource. Defaults to
true
.- Replica
Count int The number of replica's which should be created.
- map[string]string
A mapping of tags which should be assigned to the Search Service.
- resource
Group StringName The name of the Resource Group where the Search Service should exist. Changing this forces a new Search Service to be created.
- sku String
The SKU which should be used for this Search Service. Possible values are
basic
,free
,standard
,standard2
,standard3
,storage_optimized_l1
andstorage_optimized_l2
. Changing this forces a new Search Service to be created.- allowed
Ips List<String> A list of IPv4 addresses or CIDRs that are allowed access to the search service endpoint.
- identity
Service
Identity Args An
identity
block as defined below.- location String
The Azure Region where the Search Service should exist. Changing this forces a new Search Service to be created.
- name String
The Name which should be used for this Search Service. Changing this forces a new Search Service to be created.
- partition
Count Integer The number of partitions which should be created.
- public
Network BooleanAccess Enabled Whether or not public network access is allowed for this resource. Defaults to
true
.- replica
Count Integer The number of replica's which should be created.
- Map<String,String>
A mapping of tags which should be assigned to the Search Service.
- resource
Group stringName The name of the Resource Group where the Search Service should exist. Changing this forces a new Search Service to be created.
- sku string
The SKU which should be used for this Search Service. Possible values are
basic
,free
,standard
,standard2
,standard3
,storage_optimized_l1
andstorage_optimized_l2
. Changing this forces a new Search Service to be created.- allowed
Ips string[] A list of IPv4 addresses or CIDRs that are allowed access to the search service endpoint.
- identity
Service
Identity Args An
identity
block as defined below.- location string
The Azure Region where the Search Service should exist. Changing this forces a new Search Service to be created.
- name string
The Name which should be used for this Search Service. Changing this forces a new Search Service to be created.
- partition
Count number The number of partitions which should be created.
- public
Network booleanAccess Enabled Whether or not public network access is allowed for this resource. Defaults to
true
.- replica
Count number The number of replica's which should be created.
- {[key: string]: string}
A mapping of tags which should be assigned to the Search Service.
- resource_
group_ strname The name of the Resource Group where the Search Service should exist. Changing this forces a new Search Service to be created.
- sku str
The SKU which should be used for this Search Service. Possible values are
basic
,free
,standard
,standard2
,standard3
,storage_optimized_l1
andstorage_optimized_l2
. Changing this forces a new Search Service to be created.- allowed_
ips Sequence[str] A list of IPv4 addresses or CIDRs that are allowed access to the search service endpoint.
- identity
Service
Identity Args An
identity
block as defined below.- location str
The Azure Region where the Search Service should exist. Changing this forces a new Search Service to be created.
- name str
The Name which should be used for this Search Service. Changing this forces a new Search Service to be created.
- partition_
count int The number of partitions which should be created.
- public_
network_ boolaccess_ enabled Whether or not public network access is allowed for this resource. Defaults to
true
.- replica_
count int The number of replica's which should be created.
- Mapping[str, str]
A mapping of tags which should be assigned to the Search Service.
- resource
Group StringName The name of the Resource Group where the Search Service should exist. Changing this forces a new Search Service to be created.
- sku String
The SKU which should be used for this Search Service. Possible values are
basic
,free
,standard
,standard2
,standard3
,storage_optimized_l1
andstorage_optimized_l2
. Changing this forces a new Search Service to be created.- allowed
Ips List<String> A list of IPv4 addresses or CIDRs that are allowed access to the search service endpoint.
- identity Property Map
An
identity
block as defined below.- location String
The Azure Region where the Search Service should exist. Changing this forces a new Search Service to be created.
- name String
The Name which should be used for this Search Service. Changing this forces a new Search Service to be created.
- partition
Count Number The number of partitions which should be created.
- public
Network BooleanAccess Enabled Whether or not public network access is allowed for this resource. Defaults to
true
.- replica
Count Number The number of replica's which should be created.
- Map<String>
A mapping of tags which should be assigned to the Search Service.
Outputs
All input properties are implicitly available as output properties. Additionally, the Service resource produces the following output properties:
- Id string
The provider-assigned unique ID for this managed resource.
- Primary
Key string The Primary Key used for Search Service Administration.
- Query
Keys List<ServiceQuery Key> A
query_keys
block as defined below.- Secondary
Key string The Secondary Key used for Search Service Administration.
- Id string
The provider-assigned unique ID for this managed resource.
- Primary
Key string The Primary Key used for Search Service Administration.
- Query
Keys []ServiceQuery Key A
query_keys
block as defined below.- Secondary
Key string The Secondary Key used for Search Service Administration.
- id String
The provider-assigned unique ID for this managed resource.
- primary
Key String The Primary Key used for Search Service Administration.
- query
Keys List<ServiceQuery Key> A
query_keys
block as defined below.- secondary
Key String The Secondary Key used for Search Service Administration.
- id string
The provider-assigned unique ID for this managed resource.
- primary
Key string The Primary Key used for Search Service Administration.
- query
Keys ServiceQuery Key[] A
query_keys
block as defined below.- secondary
Key string The Secondary Key used for Search Service Administration.
- id str
The provider-assigned unique ID for this managed resource.
- primary_
key str The Primary Key used for Search Service Administration.
- query_
keys Sequence[ServiceQuery Key] A
query_keys
block as defined below.- secondary_
key str The Secondary Key used for Search Service Administration.
- id String
The provider-assigned unique ID for this managed resource.
- primary
Key String The Primary Key used for Search Service Administration.
- query
Keys List<Property Map> A
query_keys
block as defined below.- secondary
Key String The Secondary Key used for Search Service Administration.
Look up Existing Service Resource
Get an existing Service resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: ServiceState, opts?: CustomResourceOptions): Service
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
allowed_ips: Optional[Sequence[str]] = None,
identity: Optional[ServiceIdentityArgs] = None,
location: Optional[str] = None,
name: Optional[str] = None,
partition_count: Optional[int] = None,
primary_key: Optional[str] = None,
public_network_access_enabled: Optional[bool] = None,
query_keys: Optional[Sequence[ServiceQueryKeyArgs]] = None,
replica_count: Optional[int] = None,
resource_group_name: Optional[str] = None,
secondary_key: Optional[str] = None,
sku: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None) -> Service
func GetService(ctx *Context, name string, id IDInput, state *ServiceState, opts ...ResourceOption) (*Service, error)
public static Service Get(string name, Input<string> id, ServiceState? state, CustomResourceOptions? opts = null)
public static Service get(String name, Output<String> id, ServiceState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Allowed
Ips List<string> A list of IPv4 addresses or CIDRs that are allowed access to the search service endpoint.
- Identity
Service
Identity Args An
identity
block as defined below.- Location string
The Azure Region where the Search Service should exist. Changing this forces a new Search Service to be created.
- Name string
The Name which should be used for this Search Service. Changing this forces a new Search Service to be created.
- Partition
Count int The number of partitions which should be created.
- Primary
Key string The Primary Key used for Search Service Administration.
- Public
Network boolAccess Enabled Whether or not public network access is allowed for this resource. Defaults to
true
.- Query
Keys List<ServiceQuery Key Args> A
query_keys
block as defined below.- Replica
Count int The number of replica's which should be created.
- Resource
Group stringName The name of the Resource Group where the Search Service should exist. Changing this forces a new Search Service to be created.
- Secondary
Key string The Secondary Key used for Search Service Administration.
- Sku string
The SKU which should be used for this Search Service. Possible values are
basic
,free
,standard
,standard2
,standard3
,storage_optimized_l1
andstorage_optimized_l2
. Changing this forces a new Search Service to be created.- Dictionary<string, string>
A mapping of tags which should be assigned to the Search Service.
- Allowed
Ips []string A list of IPv4 addresses or CIDRs that are allowed access to the search service endpoint.
- Identity
Service
Identity Args An
identity
block as defined below.- Location string
The Azure Region where the Search Service should exist. Changing this forces a new Search Service to be created.
- Name string
The Name which should be used for this Search Service. Changing this forces a new Search Service to be created.
- Partition
Count int The number of partitions which should be created.
- Primary
Key string The Primary Key used for Search Service Administration.
- Public
Network boolAccess Enabled Whether or not public network access is allowed for this resource. Defaults to
true
.- Query
Keys []ServiceQuery Key Args A
query_keys
block as defined below.- Replica
Count int The number of replica's which should be created.
- Resource
Group stringName The name of the Resource Group where the Search Service should exist. Changing this forces a new Search Service to be created.
- Secondary
Key string The Secondary Key used for Search Service Administration.
- Sku string
The SKU which should be used for this Search Service. Possible values are
basic
,free
,standard
,standard2
,standard3
,storage_optimized_l1
andstorage_optimized_l2
. Changing this forces a new Search Service to be created.- map[string]string
A mapping of tags which should be assigned to the Search Service.
- allowed
Ips List<String> A list of IPv4 addresses or CIDRs that are allowed access to the search service endpoint.
- identity
Service
Identity Args An
identity
block as defined below.- location String
The Azure Region where the Search Service should exist. Changing this forces a new Search Service to be created.
- name String
The Name which should be used for this Search Service. Changing this forces a new Search Service to be created.
- partition
Count Integer The number of partitions which should be created.
- primary
Key String The Primary Key used for Search Service Administration.
- public
Network BooleanAccess Enabled Whether or not public network access is allowed for this resource. Defaults to
true
.- query
Keys List<ServiceQuery Key Args> A
query_keys
block as defined below.- replica
Count Integer The number of replica's which should be created.
- resource
Group StringName The name of the Resource Group where the Search Service should exist. Changing this forces a new Search Service to be created.
- secondary
Key String The Secondary Key used for Search Service Administration.
- sku String
The SKU which should be used for this Search Service. Possible values are
basic
,free
,standard
,standard2
,standard3
,storage_optimized_l1
andstorage_optimized_l2
. Changing this forces a new Search Service to be created.- Map<String,String>
A mapping of tags which should be assigned to the Search Service.
- allowed
Ips string[] A list of IPv4 addresses or CIDRs that are allowed access to the search service endpoint.
- identity
Service
Identity Args An
identity
block as defined below.- location string
The Azure Region where the Search Service should exist. Changing this forces a new Search Service to be created.
- name string
The Name which should be used for this Search Service. Changing this forces a new Search Service to be created.
- partition
Count number The number of partitions which should be created.
- primary
Key string The Primary Key used for Search Service Administration.
- public
Network booleanAccess Enabled Whether or not public network access is allowed for this resource. Defaults to
true
.- query
Keys ServiceQuery Key Args[] A
query_keys
block as defined below.- replica
Count number The number of replica's which should be created.
- resource
Group stringName The name of the Resource Group where the Search Service should exist. Changing this forces a new Search Service to be created.
- secondary
Key string The Secondary Key used for Search Service Administration.
- sku string
The SKU which should be used for this Search Service. Possible values are
basic
,free
,standard
,standard2
,standard3
,storage_optimized_l1
andstorage_optimized_l2
. Changing this forces a new Search Service to be created.- {[key: string]: string}
A mapping of tags which should be assigned to the Search Service.
- allowed_
ips Sequence[str] A list of IPv4 addresses or CIDRs that are allowed access to the search service endpoint.
- identity
Service
Identity Args An
identity
block as defined below.- location str
The Azure Region where the Search Service should exist. Changing this forces a new Search Service to be created.
- name str
The Name which should be used for this Search Service. Changing this forces a new Search Service to be created.
- partition_
count int The number of partitions which should be created.
- primary_
key str The Primary Key used for Search Service Administration.
- public_
network_ boolaccess_ enabled Whether or not public network access is allowed for this resource. Defaults to
true
.- query_
keys Sequence[ServiceQuery Key Args] A
query_keys
block as defined below.- replica_
count int The number of replica's which should be created.
- resource_
group_ strname The name of the Resource Group where the Search Service should exist. Changing this forces a new Search Service to be created.
- secondary_
key str The Secondary Key used for Search Service Administration.
- sku str
The SKU which should be used for this Search Service. Possible values are
basic
,free
,standard
,standard2
,standard3
,storage_optimized_l1
andstorage_optimized_l2
. Changing this forces a new Search Service to be created.- Mapping[str, str]
A mapping of tags which should be assigned to the Search Service.
- allowed
Ips List<String> A list of IPv4 addresses or CIDRs that are allowed access to the search service endpoint.
- identity Property Map
An
identity
block as defined below.- location String
The Azure Region where the Search Service should exist. Changing this forces a new Search Service to be created.
- name String
The Name which should be used for this Search Service. Changing this forces a new Search Service to be created.
- partition
Count Number The number of partitions which should be created.
- primary
Key String The Primary Key used for Search Service Administration.
- public
Network BooleanAccess Enabled Whether or not public network access is allowed for this resource. Defaults to
true
.- query
Keys List<Property Map> A
query_keys
block as defined below.- replica
Count Number The number of replica's which should be created.
- resource
Group StringName The name of the Resource Group where the Search Service should exist. Changing this forces a new Search Service to be created.
- secondary
Key String The Secondary Key used for Search Service Administration.
- sku String
The SKU which should be used for this Search Service. Possible values are
basic
,free
,standard
,standard2
,standard3
,storage_optimized_l1
andstorage_optimized_l2
. Changing this forces a new Search Service to be created.- Map<String>
A mapping of tags which should be assigned to the Search Service.
Supporting Types
ServiceIdentity
- Type string
Specifies the type of Managed Service Identity that should be configured on this Search Service. The only possible value is
SystemAssigned
.- Principal
Id string The Principal ID associated with this Managed Service Identity.
- Tenant
Id string The Tenant ID associated with this Managed Service Identity.
- Type string
Specifies the type of Managed Service Identity that should be configured on this Search Service. The only possible value is
SystemAssigned
.- Principal
Id string The Principal ID associated with this Managed Service Identity.
- Tenant
Id string The Tenant ID associated with this Managed Service Identity.
- type String
Specifies the type of Managed Service Identity that should be configured on this Search Service. The only possible value is
SystemAssigned
.- principal
Id String The Principal ID associated with this Managed Service Identity.
- tenant
Id String The Tenant ID associated with this Managed Service Identity.
- type string
Specifies the type of Managed Service Identity that should be configured on this Search Service. The only possible value is
SystemAssigned
.- principal
Id string The Principal ID associated with this Managed Service Identity.
- tenant
Id string The Tenant ID associated with this Managed Service Identity.
- type str
Specifies the type of Managed Service Identity that should be configured on this Search Service. The only possible value is
SystemAssigned
.- principal_
id str The Principal ID associated with this Managed Service Identity.
- tenant_
id str The Tenant ID associated with this Managed Service Identity.
- type String
Specifies the type of Managed Service Identity that should be configured on this Search Service. The only possible value is
SystemAssigned
.- principal
Id String The Principal ID associated with this Managed Service Identity.
- tenant
Id String The Tenant ID associated with this Managed Service Identity.
ServiceQueryKey
Import
Search Services can be imported using the resource id
, e.g.
$ pulumi import azure:search/service:Service example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.Search/searchServices/service1
Package Details
- Repository
- Azure Classic pulumi/pulumi-azure
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
azurerm
Terraform Provider.