search

package
v5.77.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 13, 2024 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type GetServiceIdentity 

type GetServiceIdentity struct {
	// The (Client) ID of the Service Principal.
	PrincipalId string `pulumi:"principalId"`
	// The ID of the Tenant the Service Principal is assigned in.
	TenantId string `pulumi:"tenantId"`
	// The identity type of this Managed Service Identity.
	Type string `pulumi:"type"`
}

type GetServiceIdentityArgs 

type GetServiceIdentityArgs struct {
	// The (Client) ID of the Service Principal.
	PrincipalId pulumi.StringInput `pulumi:"principalId"`
	// The ID of the Tenant the Service Principal is assigned in.
	TenantId pulumi.StringInput `pulumi:"tenantId"`
	// The identity type of this Managed Service Identity.
	Type pulumi.StringInput `pulumi:"type"`
}

func (GetServiceIdentityArgs) ElementType 

func (GetServiceIdentityArgs) ElementType() reflect.Type

func (GetServiceIdentityArgs) ToGetServiceIdentityOutput 

func (i GetServiceIdentityArgs) ToGetServiceIdentityOutput() GetServiceIdentityOutput

func (GetServiceIdentityArgs) ToGetServiceIdentityOutputWithContext 

func (i GetServiceIdentityArgs) ToGetServiceIdentityOutputWithContext(ctx context.Context) GetServiceIdentityOutput

type GetServiceIdentityArray 

type GetServiceIdentityArray []GetServiceIdentityInput

func (GetServiceIdentityArray) ElementType 

func (GetServiceIdentityArray) ElementType() reflect.Type

func (GetServiceIdentityArray) ToGetServiceIdentityArrayOutput 

func (i GetServiceIdentityArray) ToGetServiceIdentityArrayOutput() GetServiceIdentityArrayOutput

func (GetServiceIdentityArray) ToGetServiceIdentityArrayOutputWithContext 

func (i GetServiceIdentityArray) ToGetServiceIdentityArrayOutputWithContext(ctx context.Context) GetServiceIdentityArrayOutput

type GetServiceIdentityArrayInput 

type GetServiceIdentityArrayInput interface {
	pulumi.Input

	ToGetServiceIdentityArrayOutput() GetServiceIdentityArrayOutput
	ToGetServiceIdentityArrayOutputWithContext(context.Context) GetServiceIdentityArrayOutput
}

GetServiceIdentityArrayInput is an input type that accepts GetServiceIdentityArray and GetServiceIdentityArrayOutput values. You can construct a concrete instance of `GetServiceIdentityArrayInput` via: 

GetServiceIdentityArray{ GetServiceIdentityArgs{...} }

type GetServiceIdentityArrayOutput 

type GetServiceIdentityArrayOutput struct{ *pulumi.OutputState }

func (GetServiceIdentityArrayOutput) ElementType 

func (GetServiceIdentityArrayOutput) ElementType() reflect.Type

func (GetServiceIdentityArrayOutput) Index 

func (o GetServiceIdentityArrayOutput) Index(i pulumi.IntInput) GetServiceIdentityOutput

func (GetServiceIdentityArrayOutput) ToGetServiceIdentityArrayOutput 

func (o GetServiceIdentityArrayOutput) ToGetServiceIdentityArrayOutput() GetServiceIdentityArrayOutput

func (GetServiceIdentityArrayOutput) ToGetServiceIdentityArrayOutputWithContext 

func (o GetServiceIdentityArrayOutput) ToGetServiceIdentityArrayOutputWithContext(ctx context.Context) GetServiceIdentityArrayOutput

type GetServiceIdentityInput 

type GetServiceIdentityInput interface {
	pulumi.Input

	ToGetServiceIdentityOutput() GetServiceIdentityOutput
	ToGetServiceIdentityOutputWithContext(context.Context) GetServiceIdentityOutput
}

GetServiceIdentityInput is an input type that accepts GetServiceIdentityArgs and GetServiceIdentityOutput values. You can construct a concrete instance of `GetServiceIdentityInput` via: 

GetServiceIdentityArgs{...}

type GetServiceIdentityOutput 

type GetServiceIdentityOutput struct{ *pulumi.OutputState }

func (GetServiceIdentityOutput) ElementType 

func (GetServiceIdentityOutput) ElementType() reflect.Type

func (GetServiceIdentityOutput) PrincipalId 

func (o GetServiceIdentityOutput) PrincipalId() pulumi.StringOutput

The (Client) ID of the Service Principal.

func (GetServiceIdentityOutput) TenantId 

func (o GetServiceIdentityOutput) TenantId() pulumi.StringOutput

The ID of the Tenant the Service Principal is assigned in.

func (GetServiceIdentityOutput) ToGetServiceIdentityOutput 

func (o GetServiceIdentityOutput) ToGetServiceIdentityOutput() GetServiceIdentityOutput

func (GetServiceIdentityOutput) ToGetServiceIdentityOutputWithContext 

func (o GetServiceIdentityOutput) ToGetServiceIdentityOutputWithContext(ctx context.Context) GetServiceIdentityOutput

func (GetServiceIdentityOutput) Type 

func (o GetServiceIdentityOutput) Type() pulumi.StringOutput

The identity type of this Managed Service Identity.

type GetServiceQueryKey 

type GetServiceQueryKey struct {
	// The value of this Query Key.
	Key string `pulumi:"key"`
	// The Name of the Search Service.
	Name string `pulumi:"name"`
}

type GetServiceQueryKeyArgs 

type GetServiceQueryKeyArgs struct {
	// The value of this Query Key.
	Key pulumi.StringInput `pulumi:"key"`
	// The Name of the Search Service.
	Name pulumi.StringInput `pulumi:"name"`
}

func (GetServiceQueryKeyArgs) ElementType 

func (GetServiceQueryKeyArgs) ElementType() reflect.Type

func (GetServiceQueryKeyArgs) ToGetServiceQueryKeyOutput 

func (i GetServiceQueryKeyArgs) ToGetServiceQueryKeyOutput() GetServiceQueryKeyOutput

func (GetServiceQueryKeyArgs) ToGetServiceQueryKeyOutputWithContext 

func (i GetServiceQueryKeyArgs) ToGetServiceQueryKeyOutputWithContext(ctx context.Context) GetServiceQueryKeyOutput

type GetServiceQueryKeyArray 

type GetServiceQueryKeyArray []GetServiceQueryKeyInput

func (GetServiceQueryKeyArray) ElementType 

func (GetServiceQueryKeyArray) ElementType() reflect.Type

func (GetServiceQueryKeyArray) ToGetServiceQueryKeyArrayOutput 

func (i GetServiceQueryKeyArray) ToGetServiceQueryKeyArrayOutput() GetServiceQueryKeyArrayOutput

func (GetServiceQueryKeyArray) ToGetServiceQueryKeyArrayOutputWithContext 

func (i GetServiceQueryKeyArray) ToGetServiceQueryKeyArrayOutputWithContext(ctx context.Context) GetServiceQueryKeyArrayOutput

type GetServiceQueryKeyArrayInput 

type GetServiceQueryKeyArrayInput interface {
	pulumi.Input

	ToGetServiceQueryKeyArrayOutput() GetServiceQueryKeyArrayOutput
	ToGetServiceQueryKeyArrayOutputWithContext(context.Context) GetServiceQueryKeyArrayOutput
}

GetServiceQueryKeyArrayInput is an input type that accepts GetServiceQueryKeyArray and GetServiceQueryKeyArrayOutput values. You can construct a concrete instance of `GetServiceQueryKeyArrayInput` via: 

GetServiceQueryKeyArray{ GetServiceQueryKeyArgs{...} }

type GetServiceQueryKeyArrayOutput 

type GetServiceQueryKeyArrayOutput struct{ *pulumi.OutputState }

func (GetServiceQueryKeyArrayOutput) ElementType 

func (GetServiceQueryKeyArrayOutput) ElementType() reflect.Type

func (GetServiceQueryKeyArrayOutput) Index 

func (o GetServiceQueryKeyArrayOutput) Index(i pulumi.IntInput) GetServiceQueryKeyOutput

func (GetServiceQueryKeyArrayOutput) ToGetServiceQueryKeyArrayOutput 

func (o GetServiceQueryKeyArrayOutput) ToGetServiceQueryKeyArrayOutput() GetServiceQueryKeyArrayOutput

func (GetServiceQueryKeyArrayOutput) ToGetServiceQueryKeyArrayOutputWithContext 

func (o GetServiceQueryKeyArrayOutput) ToGetServiceQueryKeyArrayOutputWithContext(ctx context.Context) GetServiceQueryKeyArrayOutput

type GetServiceQueryKeyInput 

type GetServiceQueryKeyInput interface {
	pulumi.Input

	ToGetServiceQueryKeyOutput() GetServiceQueryKeyOutput
	ToGetServiceQueryKeyOutputWithContext(context.Context) GetServiceQueryKeyOutput
}

GetServiceQueryKeyInput is an input type that accepts GetServiceQueryKeyArgs and GetServiceQueryKeyOutput values. You can construct a concrete instance of `GetServiceQueryKeyInput` via: 

GetServiceQueryKeyArgs{...}

type GetServiceQueryKeyOutput 

type GetServiceQueryKeyOutput struct{ *pulumi.OutputState }

func (GetServiceQueryKeyOutput) ElementType 

func (GetServiceQueryKeyOutput) ElementType() reflect.Type

func (GetServiceQueryKeyOutput) Key 

func (o GetServiceQueryKeyOutput) Key() pulumi.StringOutput

The value of this Query Key.

func (GetServiceQueryKeyOutput) Name 

func (o GetServiceQueryKeyOutput) Name() pulumi.StringOutput

The Name of the Search Service.

func (GetServiceQueryKeyOutput) ToGetServiceQueryKeyOutput 

func (o GetServiceQueryKeyOutput) ToGetServiceQueryKeyOutput() GetServiceQueryKeyOutput

func (GetServiceQueryKeyOutput) ToGetServiceQueryKeyOutputWithContext 

func (o GetServiceQueryKeyOutput) ToGetServiceQueryKeyOutputWithContext(ctx context.Context) GetServiceQueryKeyOutput

type LookupServiceArgs 

type LookupServiceArgs struct {
	// The Name of the Search Service.
	Name string `pulumi:"name"`
	// The name of the Resource Group where the Search Service exists.
	ResourceGroupName string `pulumi:"resourceGroupName"`
}

A collection of arguments for invoking getService.

type LookupServiceOutputArgs 

type LookupServiceOutputArgs struct {
	// The Name of the Search Service.
	Name pulumi.StringInput `pulumi:"name"`
	// The name of the Resource Group where the Search Service exists.
	ResourceGroupName pulumi.StringInput `pulumi:"resourceGroupName"`
}

A collection of arguments for invoking getService.

func (LookupServiceOutputArgs) ElementType 

func (LookupServiceOutputArgs) ElementType() reflect.Type

type LookupServiceResult 

type LookupServiceResult struct {
	// The provider-assigned unique ID for this managed resource.
	Id string `pulumi:"id"`
	// An `identity` block as defined below.
	Identities []GetServiceIdentity `pulumi:"identities"`
	// The name of this Query Key.
	Name string `pulumi:"name"`
	// The number of partitions which have been created.
	PartitionCount int `pulumi:"partitionCount"`
	// The Primary Key used for Search Service Administration.
	PrimaryKey string `pulumi:"primaryKey"`
	// Whether or not public network access is enabled for this resource.
	PublicNetworkAccessEnabled bool `pulumi:"publicNetworkAccessEnabled"`
	// A `queryKeys` block as defined below.
	QueryKeys []GetServiceQueryKey `pulumi:"queryKeys"`
	// The number of replica's which have been created.
	ReplicaCount      int    `pulumi:"replicaCount"`
	ResourceGroupName string `pulumi:"resourceGroupName"`
	// The Secondary Key used for Search Service Administration.
	SecondaryKey string `pulumi:"secondaryKey"`
}

A collection of values returned by getService.

func LookupService 

func LookupService(ctx *pulumi.Context, args *LookupServiceArgs, opts ...pulumi.InvokeOption) (*LookupServiceResult, error)

Manages a Search Service.

## Example Usage

```go 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, "example", &core.ResourceGroupArgs{
			Name:     pulumi.String("example-resources"),
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		_ = search.LookupServiceOutput(ctx, search.GetServiceOutputArgs{
			Name:              pulumi.String("example-search-service"),
			ResourceGroupName: exampleResourceGroup.Name,
		}, nil)
		return nil
	})
}

```

type LookupServiceResultOutput 

type LookupServiceResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getService.

func LookupServiceOutput 

func LookupServiceOutput(ctx *pulumi.Context, args LookupServiceOutputArgs, opts ...pulumi.InvokeOption) LookupServiceResultOutput

func (LookupServiceResultOutput) ElementType 

func (LookupServiceResultOutput) ElementType() reflect.Type

func (LookupServiceResultOutput) Id 

func (o LookupServiceResultOutput) Id() pulumi.StringOutput

The provider-assigned unique ID for this managed resource.

func (LookupServiceResultOutput) Identities 

func (o LookupServiceResultOutput) Identities() GetServiceIdentityArrayOutput

An `identity` block as defined below.

func (LookupServiceResultOutput) Name 

func (o LookupServiceResultOutput) Name() pulumi.StringOutput

The name of this Query Key.

func (LookupServiceResultOutput) PartitionCount 

func (o LookupServiceResultOutput) PartitionCount() pulumi.IntOutput

The number of partitions which have been created.

func (LookupServiceResultOutput) PrimaryKey 

func (o LookupServiceResultOutput) PrimaryKey() pulumi.StringOutput

The Primary Key used for Search Service Administration.

func (LookupServiceResultOutput) PublicNetworkAccessEnabled 

func (o LookupServiceResultOutput) PublicNetworkAccessEnabled() pulumi.BoolOutput

Whether or not public network access is enabled for this resource.

func (LookupServiceResultOutput) QueryKeys 

func (o LookupServiceResultOutput) QueryKeys() GetServiceQueryKeyArrayOutput

A `queryKeys` block as defined below.

func (LookupServiceResultOutput) ReplicaCount 

func (o LookupServiceResultOutput) ReplicaCount() pulumi.IntOutput

The number of replica's which have been created.

func (LookupServiceResultOutput) ResourceGroupName 

func (o LookupServiceResultOutput) ResourceGroupName() pulumi.StringOutput

func (LookupServiceResultOutput) SecondaryKey 

func (o LookupServiceResultOutput) SecondaryKey() pulumi.StringOutput

The Secondary Key used for Search Service Administration.

func (LookupServiceResultOutput) ToLookupServiceResultOutput 

func (o LookupServiceResultOutput) ToLookupServiceResultOutput() LookupServiceResultOutput

func (LookupServiceResultOutput) ToLookupServiceResultOutputWithContext 

func (o LookupServiceResultOutput) ToLookupServiceResultOutputWithContext(ctx context.Context) LookupServiceResultOutput

type Service 

type Service struct {
	pulumi.CustomResourceState

	// 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.StringArrayOutput `pulumi:"allowedIps"`
	// 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.StringPtrOutput `pulumi:"authenticationFailureMode"`
	// Specifies whether the Search Service should enforce that non-customer resources are encrypted. Defaults to `false`.
	CustomerManagedKeyEnforcementEnabled pulumi.BoolPtrOutput `pulumi:"customerManagedKeyEnforcementEnabled"`
	// 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.StringPtrOutput `pulumi:"hostingMode"`
	// An `identity` block as defined below.
	Identity ServiceIdentityPtrOutput `pulumi:"identity"`
	// Specifies whether the Search Service allows authenticating using API Keys? Defaults to `true`.
	LocalAuthenticationEnabled pulumi.BoolPtrOutput `pulumi:"localAuthenticationEnabled"`
	// The Azure Region where the Search Service should exist. Changing this forces a new Search Service to be created.
	Location pulumi.StringOutput `pulumi:"location"`
	// The Name which should be used for this Search Service. Changing this forces a new Search Service to be created.
	Name pulumi.StringOutput `pulumi:"name"`
	// Specifies the number of partitions which should be created. This field cannot be set when using a `free` or `basic` sku ([see the Microsoft documentation](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.IntPtrOutput `pulumi:"partitionCount"`
	// The Primary Key used for Search Service Administration.
	PrimaryKey pulumi.StringOutput `pulumi:"primaryKey"`
	// Specifies whether Public Network Access is allowed for this resource. Defaults to `true`.
	PublicNetworkAccessEnabled pulumi.BoolPtrOutput `pulumi:"publicNetworkAccessEnabled"`
	// A `queryKeys` block as defined below.
	QueryKeys ServiceQueryKeyArrayOutput `pulumi:"queryKeys"`
	// 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.IntPtrOutput `pulumi:"replicaCount"`
	// The name of the Resource Group where the Search Service should exist. Changing this forces a new Search Service to be created.
	ResourceGroupName pulumi.StringOutput `pulumi:"resourceGroupName"`
	// The Secondary Key used for Search Service Administration.
	SecondaryKey pulumi.StringOutput `pulumi:"secondaryKey"`
	// 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.StringPtrOutput `pulumi:"semanticSearchSku"`
	// The SKU which should be used for this Search Service. Possible values include `basic`, `free`, `standard`, `standard2`, `standard3`, `storageOptimizedL1` and `storageOptimizedL2`. Changing this forces a new Search Service to be created.
	//
	// > The `basic` and `free` SKUs provision the Search Service in a Shared Cluster - the `standard` SKUs use a Dedicated Cluster.
	//
	// > **NOTE:** The SKUs `standard2`, `standard3`, `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.
	Sku pulumi.StringOutput `pulumi:"sku"`
	// Specifies a mapping of tags which should be assigned to this Search Service.
	Tags pulumi.StringMapOutput `pulumi:"tags"`
}

Manages a Search Service.

## Example Usage

### Supporting API Keys)

```go 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 {
		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
			Name:     pulumi.String("example-resources"),
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		_, err = search.NewService(ctx, "example", &search.ServiceArgs{
			Name:              pulumi.String("example-resource"),
			ResourceGroupName: example.Name,
			Location:          example.Location,
			Sku:               pulumi.String("standard"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

### Using Both AzureAD And API Keys)

```go 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 {
		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
			Name:     pulumi.String("example-resources"),
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		_, err = search.NewService(ctx, "example", &search.ServiceArgs{
			Name:                       pulumi.String("example-resource"),
			ResourceGroupName:          example.Name,
			Location:                   example.Location,
			Sku:                        pulumi.String("standard"),
			LocalAuthenticationEnabled: pulumi.Bool(true),
			AuthenticationFailureMode:  pulumi.String("http403"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

### Supporting Only AzureAD Authentication)

```go 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 {
		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
			Name:     pulumi.String("example-resources"),
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		_, err = search.NewService(ctx, "example", &search.ServiceArgs{
			Name:                       pulumi.String("example-resource"),
			ResourceGroupName:          example.Name,
			Location:                   example.Location,
			Sku:                        pulumi.String("standard"),
			LocalAuthenticationEnabled: pulumi.Bool(false),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## 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 ```

func GetService 

func GetService(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *ServiceState, opts ...pulumi.ResourceOption) (*Service, error)

GetService gets an existing Service resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewService 

func NewService(ctx *pulumi.Context,
	name string, args *ServiceArgs, opts ...pulumi.ResourceOption) (*Service, error)

NewService registers a new resource with the given unique name, arguments, and options.

func (*Service) ElementType 

func (*Service) ElementType() reflect.Type

func (*Service) ToServiceOutput 

func (i *Service) ToServiceOutput() ServiceOutput

func (*Service) ToServiceOutputWithContext 

func (i *Service) ToServiceOutputWithContext(ctx context.Context) ServiceOutput

type ServiceArgs 

type ServiceArgs struct {
	// 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.StringArrayInput
	// 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.StringPtrInput
	// Specifies whether the Search Service should enforce that non-customer resources are encrypted. Defaults to `false`.
	CustomerManagedKeyEnforcementEnabled pulumi.BoolPtrInput
	// 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.StringPtrInput
	// An `identity` block as defined below.
	Identity ServiceIdentityPtrInput
	// Specifies whether the Search Service allows authenticating using API Keys? Defaults to `true`.
	LocalAuthenticationEnabled pulumi.BoolPtrInput
	// The Azure Region where the Search Service should exist. Changing this forces a new Search Service to be created.
	Location pulumi.StringPtrInput
	// The Name which should be used for this Search Service. Changing this forces a new Search Service to be created.
	Name pulumi.StringPtrInput
	// Specifies the number of partitions which should be created. This field cannot be set when using a `free` or `basic` sku ([see the Microsoft documentation](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.IntPtrInput
	// Specifies whether Public Network Access is allowed for this resource. Defaults to `true`.
	PublicNetworkAccessEnabled pulumi.BoolPtrInput
	// 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.IntPtrInput
	// The name of the Resource Group where the Search Service should exist. Changing this forces a new Search Service to be created.
	ResourceGroupName pulumi.StringInput
	// 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.StringPtrInput
	// The SKU which should be used for this Search Service. Possible values include `basic`, `free`, `standard`, `standard2`, `standard3`, `storageOptimizedL1` and `storageOptimizedL2`. Changing this forces a new Search Service to be created.
	//
	// > The `basic` and `free` SKUs provision the Search Service in a Shared Cluster - the `standard` SKUs use a Dedicated Cluster.
	//
	// > **NOTE:** The SKUs `standard2`, `standard3`, `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.
	Sku pulumi.StringInput
	// Specifies a mapping of tags which should be assigned to this Search Service.
	Tags pulumi.StringMapInput
}

The set of arguments for constructing a Service resource.

func (ServiceArgs) ElementType 

func (ServiceArgs) ElementType() reflect.Type

type ServiceArray 

type ServiceArray []ServiceInput

func (ServiceArray) ElementType 

func (ServiceArray) ElementType() reflect.Type

func (ServiceArray) ToServiceArrayOutput 

func (i ServiceArray) ToServiceArrayOutput() ServiceArrayOutput

func (ServiceArray) ToServiceArrayOutputWithContext 

func (i ServiceArray) ToServiceArrayOutputWithContext(ctx context.Context) ServiceArrayOutput

type ServiceArrayInput 

type ServiceArrayInput interface {
	pulumi.Input

	ToServiceArrayOutput() ServiceArrayOutput
	ToServiceArrayOutputWithContext(context.Context) ServiceArrayOutput
}

ServiceArrayInput is an input type that accepts ServiceArray and ServiceArrayOutput values. You can construct a concrete instance of `ServiceArrayInput` via: 

ServiceArray{ ServiceArgs{...} }

type ServiceArrayOutput 

type ServiceArrayOutput struct{ *pulumi.OutputState }

func (ServiceArrayOutput) ElementType 

func (ServiceArrayOutput) ElementType() reflect.Type

func (ServiceArrayOutput) Index 

func (o ServiceArrayOutput) Index(i pulumi.IntInput) ServiceOutput

func (ServiceArrayOutput) ToServiceArrayOutput 

func (o ServiceArrayOutput) ToServiceArrayOutput() ServiceArrayOutput

func (ServiceArrayOutput) ToServiceArrayOutputWithContext 

func (o ServiceArrayOutput) ToServiceArrayOutputWithContext(ctx context.Context) ServiceArrayOutput

type ServiceIdentity 

type ServiceIdentity struct {
	// The Principal ID associated with this Managed Service Identity.
	PrincipalId *string `pulumi:"principalId"`
	// The Tenant ID associated with this Managed Service Identity.
	TenantId *string `pulumi:"tenantId"`
	// Specifies the type of Managed Service Identity that should be configured on this Search Service. The only possible value is `SystemAssigned`.
	Type string `pulumi:"type"`
}

type ServiceIdentityArgs 

type ServiceIdentityArgs struct {
	// The Principal ID associated with this Managed Service Identity.
	PrincipalId pulumi.StringPtrInput `pulumi:"principalId"`
	// The Tenant ID associated with this Managed Service Identity.
	TenantId pulumi.StringPtrInput `pulumi:"tenantId"`
	// Specifies the type of Managed Service Identity that should be configured on this Search Service. The only possible value is `SystemAssigned`.
	Type pulumi.StringInput `pulumi:"type"`
}

func (ServiceIdentityArgs) ElementType 

func (ServiceIdentityArgs) ElementType() reflect.Type

func (ServiceIdentityArgs) ToServiceIdentityOutput 

func (i ServiceIdentityArgs) ToServiceIdentityOutput() ServiceIdentityOutput

func (ServiceIdentityArgs) ToServiceIdentityOutputWithContext 

func (i ServiceIdentityArgs) ToServiceIdentityOutputWithContext(ctx context.Context) ServiceIdentityOutput

func (ServiceIdentityArgs) ToServiceIdentityPtrOutput 

func (i ServiceIdentityArgs) ToServiceIdentityPtrOutput() ServiceIdentityPtrOutput

func (ServiceIdentityArgs) ToServiceIdentityPtrOutputWithContext 

func (i ServiceIdentityArgs) ToServiceIdentityPtrOutputWithContext(ctx context.Context) ServiceIdentityPtrOutput

type ServiceIdentityInput 

type ServiceIdentityInput interface {
	pulumi.Input

	ToServiceIdentityOutput() ServiceIdentityOutput
	ToServiceIdentityOutputWithContext(context.Context) ServiceIdentityOutput
}

ServiceIdentityInput is an input type that accepts ServiceIdentityArgs and ServiceIdentityOutput values. You can construct a concrete instance of `ServiceIdentityInput` via: 

ServiceIdentityArgs{...}

type ServiceIdentityOutput 

type ServiceIdentityOutput struct{ *pulumi.OutputState }

func (ServiceIdentityOutput) ElementType 

func (ServiceIdentityOutput) ElementType() reflect.Type

func (ServiceIdentityOutput) PrincipalId 

func (o ServiceIdentityOutput) PrincipalId() pulumi.StringPtrOutput

The Principal ID associated with this Managed Service Identity.

func (ServiceIdentityOutput) TenantId 

func (o ServiceIdentityOutput) TenantId() pulumi.StringPtrOutput

The Tenant ID associated with this Managed Service Identity.

func (ServiceIdentityOutput) ToServiceIdentityOutput 

func (o ServiceIdentityOutput) ToServiceIdentityOutput() ServiceIdentityOutput

func (ServiceIdentityOutput) ToServiceIdentityOutputWithContext 

func (o ServiceIdentityOutput) ToServiceIdentityOutputWithContext(ctx context.Context) ServiceIdentityOutput

func (ServiceIdentityOutput) ToServiceIdentityPtrOutput 

func (o ServiceIdentityOutput) ToServiceIdentityPtrOutput() ServiceIdentityPtrOutput

func (ServiceIdentityOutput) ToServiceIdentityPtrOutputWithContext 

func (o ServiceIdentityOutput) ToServiceIdentityPtrOutputWithContext(ctx context.Context) ServiceIdentityPtrOutput

func (ServiceIdentityOutput) Type 

func (o ServiceIdentityOutput) Type() pulumi.StringOutput

Specifies the type of Managed Service Identity that should be configured on this Search Service. The only possible value is `SystemAssigned`.

type ServiceIdentityPtrInput 

type ServiceIdentityPtrInput interface {
	pulumi.Input

	ToServiceIdentityPtrOutput() ServiceIdentityPtrOutput
	ToServiceIdentityPtrOutputWithContext(context.Context) ServiceIdentityPtrOutput
}

ServiceIdentityPtrInput is an input type that accepts ServiceIdentityArgs, ServiceIdentityPtr and ServiceIdentityPtrOutput values. You can construct a concrete instance of `ServiceIdentityPtrInput` via: 

        ServiceIdentityArgs{...}

or:

        nil

func ServiceIdentityPtr 

func ServiceIdentityPtr(v *ServiceIdentityArgs) ServiceIdentityPtrInput

type ServiceIdentityPtrOutput 

type ServiceIdentityPtrOutput struct{ *pulumi.OutputState }

func (ServiceIdentityPtrOutput) Elem 

func (o ServiceIdentityPtrOutput) Elem() ServiceIdentityOutput

func (ServiceIdentityPtrOutput) ElementType 

func (ServiceIdentityPtrOutput) ElementType() reflect.Type

func (ServiceIdentityPtrOutput) PrincipalId 

func (o ServiceIdentityPtrOutput) PrincipalId() pulumi.StringPtrOutput

The Principal ID associated with this Managed Service Identity.

func (ServiceIdentityPtrOutput) TenantId 

func (o ServiceIdentityPtrOutput) TenantId() pulumi.StringPtrOutput

The Tenant ID associated with this Managed Service Identity.

func (ServiceIdentityPtrOutput) ToServiceIdentityPtrOutput 

func (o ServiceIdentityPtrOutput) ToServiceIdentityPtrOutput() ServiceIdentityPtrOutput

func (ServiceIdentityPtrOutput) ToServiceIdentityPtrOutputWithContext 

func (o ServiceIdentityPtrOutput) ToServiceIdentityPtrOutputWithContext(ctx context.Context) ServiceIdentityPtrOutput

func (ServiceIdentityPtrOutput) Type 

func (o ServiceIdentityPtrOutput) Type() pulumi.StringPtrOutput

Specifies the type of Managed Service Identity that should be configured on this Search Service. The only possible value is `SystemAssigned`.

type ServiceInput 

type ServiceInput interface {
	pulumi.Input

	ToServiceOutput() ServiceOutput
	ToServiceOutputWithContext(ctx context.Context) ServiceOutput
}

type ServiceMap 

type ServiceMap map[string]ServiceInput

func (ServiceMap) ElementType 

func (ServiceMap) ElementType() reflect.Type

func (ServiceMap) ToServiceMapOutput 

func (i ServiceMap) ToServiceMapOutput() ServiceMapOutput

func (ServiceMap) ToServiceMapOutputWithContext 

func (i ServiceMap) ToServiceMapOutputWithContext(ctx context.Context) ServiceMapOutput

type ServiceMapInput 

type ServiceMapInput interface {
	pulumi.Input

	ToServiceMapOutput() ServiceMapOutput
	ToServiceMapOutputWithContext(context.Context) ServiceMapOutput
}

ServiceMapInput is an input type that accepts ServiceMap and ServiceMapOutput values. You can construct a concrete instance of `ServiceMapInput` via: 

ServiceMap{ "key": ServiceArgs{...} }

type ServiceMapOutput 

type ServiceMapOutput struct{ *pulumi.OutputState }

func (ServiceMapOutput) ElementType 

func (ServiceMapOutput) ElementType() reflect.Type

func (ServiceMapOutput) MapIndex 

func (o ServiceMapOutput) MapIndex(k pulumi.StringInput) ServiceOutput

func (ServiceMapOutput) ToServiceMapOutput 

func (o ServiceMapOutput) ToServiceMapOutput() ServiceMapOutput

func (ServiceMapOutput) ToServiceMapOutputWithContext 

func (o ServiceMapOutput) ToServiceMapOutputWithContext(ctx context.Context) ServiceMapOutput

type ServiceOutput 

type ServiceOutput struct{ *pulumi.OutputState }

func (ServiceOutput) AllowedIps added in v5.5.0 

func (o ServiceOutput) AllowedIps() pulumi.StringArrayOutput

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.

func (ServiceOutput) AuthenticationFailureMode added in v5.43.0 

func (o ServiceOutput) AuthenticationFailureMode() pulumi.StringPtrOutput

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.

func (ServiceOutput) CustomerManagedKeyEnforcementEnabled added in v5.43.0 

func (o ServiceOutput) CustomerManagedKeyEnforcementEnabled() pulumi.BoolPtrOutput

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

func (ServiceOutput) ElementType 

func (ServiceOutput) ElementType() reflect.Type

func (ServiceOutput) HostingMode added in v5.43.0 

func (o ServiceOutput) HostingMode() pulumi.StringPtrOutput

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

func (ServiceOutput) Identity added in v5.5.0 

func (o ServiceOutput) Identity() ServiceIdentityPtrOutput

An `identity` block as defined below.

func (ServiceOutput) LocalAuthenticationEnabled added in v5.43.0 

func (o ServiceOutput) LocalAuthenticationEnabled() pulumi.BoolPtrOutput

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

func (ServiceOutput) Location added in v5.5.0 

func (o ServiceOutput) Location() pulumi.StringOutput

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

func (ServiceOutput) Name added in v5.5.0 

func (o ServiceOutput) Name() pulumi.StringOutput

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

func (ServiceOutput) PartitionCount added in v5.5.0 

func (o ServiceOutput) PartitionCount() pulumi.IntPtrOutput

Specifies the number of partitions which should be created. This field cannot be set when using a `free` or `basic` sku ([see the Microsoft documentation](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`.

func (ServiceOutput) PrimaryKey added in v5.5.0 

func (o ServiceOutput) PrimaryKey() pulumi.StringOutput

The Primary Key used for Search Service Administration.

func (ServiceOutput) PublicNetworkAccessEnabled added in v5.5.0 

func (o ServiceOutput) PublicNetworkAccessEnabled() pulumi.BoolPtrOutput

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

func (ServiceOutput) QueryKeys added in v5.5.0 

func (o ServiceOutput) QueryKeys() ServiceQueryKeyArrayOutput

A `queryKeys` block as defined below.

func (ServiceOutput) ReplicaCount added in v5.5.0 

func (o ServiceOutput) ReplicaCount() pulumi.IntPtrOutput

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

func (ServiceOutput) ResourceGroupName added in v5.5.0 

func (o ServiceOutput) ResourceGroupName() pulumi.StringOutput

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

func (ServiceOutput) SecondaryKey added in v5.5.0 

func (o ServiceOutput) SecondaryKey() pulumi.StringOutput

The Secondary Key used for Search Service Administration.

func (ServiceOutput) SemanticSearchSku added in v5.54.0 

func (o ServiceOutput) SemanticSearchSku() pulumi.StringPtrOutput

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.

func (ServiceOutput) Sku added in v5.5.0 

func (o ServiceOutput) Sku() pulumi.StringOutput

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

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

> **NOTE:** The SKUs `standard2`, `standard3`, `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.

func (ServiceOutput) Tags added in v5.5.0 

func (o ServiceOutput) Tags() pulumi.StringMapOutput

Specifies a mapping of tags which should be assigned to this Search Service.

func (ServiceOutput) ToServiceOutput 

func (o ServiceOutput) ToServiceOutput() ServiceOutput

func (ServiceOutput) ToServiceOutputWithContext 

func (o ServiceOutput) ToServiceOutputWithContext(ctx context.Context) ServiceOutput

type ServiceQueryKey 

type ServiceQueryKey struct {
	// The value of this Query Key.
	Key *string `pulumi:"key"`
	// The Name which should be used for this Search Service. Changing this forces a new Search Service to be created.
	Name *string `pulumi:"name"`
}

type ServiceQueryKeyArgs 

type ServiceQueryKeyArgs struct {
	// The value of this Query Key.
	Key pulumi.StringPtrInput `pulumi:"key"`
	// The Name which should be used for this Search Service. Changing this forces a new Search Service to be created.
	Name pulumi.StringPtrInput `pulumi:"name"`
}

func (ServiceQueryKeyArgs) ElementType 

func (ServiceQueryKeyArgs) ElementType() reflect.Type

func (ServiceQueryKeyArgs) ToServiceQueryKeyOutput 

func (i ServiceQueryKeyArgs) ToServiceQueryKeyOutput() ServiceQueryKeyOutput

func (ServiceQueryKeyArgs) ToServiceQueryKeyOutputWithContext 

func (i ServiceQueryKeyArgs) ToServiceQueryKeyOutputWithContext(ctx context.Context) ServiceQueryKeyOutput

type ServiceQueryKeyArray 

type ServiceQueryKeyArray []ServiceQueryKeyInput

func (ServiceQueryKeyArray) ElementType 

func (ServiceQueryKeyArray) ElementType() reflect.Type

func (ServiceQueryKeyArray) ToServiceQueryKeyArrayOutput 

func (i ServiceQueryKeyArray) ToServiceQueryKeyArrayOutput() ServiceQueryKeyArrayOutput

func (ServiceQueryKeyArray) ToServiceQueryKeyArrayOutputWithContext 

func (i ServiceQueryKeyArray) ToServiceQueryKeyArrayOutputWithContext(ctx context.Context) ServiceQueryKeyArrayOutput

type ServiceQueryKeyArrayInput 

type ServiceQueryKeyArrayInput interface {
	pulumi.Input

	ToServiceQueryKeyArrayOutput() ServiceQueryKeyArrayOutput
	ToServiceQueryKeyArrayOutputWithContext(context.Context) ServiceQueryKeyArrayOutput
}

ServiceQueryKeyArrayInput is an input type that accepts ServiceQueryKeyArray and ServiceQueryKeyArrayOutput values. You can construct a concrete instance of `ServiceQueryKeyArrayInput` via: 

ServiceQueryKeyArray{ ServiceQueryKeyArgs{...} }

type ServiceQueryKeyArrayOutput 

type ServiceQueryKeyArrayOutput struct{ *pulumi.OutputState }

func (ServiceQueryKeyArrayOutput) ElementType 

func (ServiceQueryKeyArrayOutput) ElementType() reflect.Type

func (ServiceQueryKeyArrayOutput) Index 

func (o ServiceQueryKeyArrayOutput) Index(i pulumi.IntInput) ServiceQueryKeyOutput

func (ServiceQueryKeyArrayOutput) ToServiceQueryKeyArrayOutput 

func (o ServiceQueryKeyArrayOutput) ToServiceQueryKeyArrayOutput() ServiceQueryKeyArrayOutput

func (ServiceQueryKeyArrayOutput) ToServiceQueryKeyArrayOutputWithContext 

func (o ServiceQueryKeyArrayOutput) ToServiceQueryKeyArrayOutputWithContext(ctx context.Context) ServiceQueryKeyArrayOutput

type ServiceQueryKeyInput 

type ServiceQueryKeyInput interface {
	pulumi.Input

	ToServiceQueryKeyOutput() ServiceQueryKeyOutput
	ToServiceQueryKeyOutputWithContext(context.Context) ServiceQueryKeyOutput
}

ServiceQueryKeyInput is an input type that accepts ServiceQueryKeyArgs and ServiceQueryKeyOutput values. You can construct a concrete instance of `ServiceQueryKeyInput` via: 

ServiceQueryKeyArgs{...}

type ServiceQueryKeyOutput 

type ServiceQueryKeyOutput struct{ *pulumi.OutputState }

func (ServiceQueryKeyOutput) ElementType 

func (ServiceQueryKeyOutput) ElementType() reflect.Type

func (ServiceQueryKeyOutput) Key 

func (o ServiceQueryKeyOutput) Key() pulumi.StringPtrOutput

The value of this Query Key.

func (ServiceQueryKeyOutput) Name 

func (o ServiceQueryKeyOutput) Name() pulumi.StringPtrOutput

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

func (ServiceQueryKeyOutput) ToServiceQueryKeyOutput 

func (o ServiceQueryKeyOutput) ToServiceQueryKeyOutput() ServiceQueryKeyOutput

func (ServiceQueryKeyOutput) ToServiceQueryKeyOutputWithContext 

func (o ServiceQueryKeyOutput) ToServiceQueryKeyOutputWithContext(ctx context.Context) ServiceQueryKeyOutput

type ServiceState 

type ServiceState struct {
	// 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.StringArrayInput
	// 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.StringPtrInput
	// Specifies whether the Search Service should enforce that non-customer resources are encrypted. Defaults to `false`.
	CustomerManagedKeyEnforcementEnabled pulumi.BoolPtrInput
	// 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.StringPtrInput
	// An `identity` block as defined below.
	Identity ServiceIdentityPtrInput
	// Specifies whether the Search Service allows authenticating using API Keys? Defaults to `true`.
	LocalAuthenticationEnabled pulumi.BoolPtrInput
	// The Azure Region where the Search Service should exist. Changing this forces a new Search Service to be created.
	Location pulumi.StringPtrInput
	// The Name which should be used for this Search Service. Changing this forces a new Search Service to be created.
	Name pulumi.StringPtrInput
	// Specifies the number of partitions which should be created. This field cannot be set when using a `free` or `basic` sku ([see the Microsoft documentation](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.IntPtrInput
	// The Primary Key used for Search Service Administration.
	PrimaryKey pulumi.StringPtrInput
	// Specifies whether Public Network Access is allowed for this resource. Defaults to `true`.
	PublicNetworkAccessEnabled pulumi.BoolPtrInput
	// A `queryKeys` block as defined below.
	QueryKeys ServiceQueryKeyArrayInput
	// 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.IntPtrInput
	// The name of the Resource Group where the Search Service should exist. Changing this forces a new Search Service to be created.
	ResourceGroupName pulumi.StringPtrInput
	// The Secondary Key used for Search Service Administration.
	SecondaryKey pulumi.StringPtrInput
	// 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.StringPtrInput
	// The SKU which should be used for this Search Service. Possible values include `basic`, `free`, `standard`, `standard2`, `standard3`, `storageOptimizedL1` and `storageOptimizedL2`. Changing this forces a new Search Service to be created.
	//
	// > The `basic` and `free` SKUs provision the Search Service in a Shared Cluster - the `standard` SKUs use a Dedicated Cluster.
	//
	// > **NOTE:** The SKUs `standard2`, `standard3`, `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.
	Sku pulumi.StringPtrInput
	// Specifies a mapping of tags which should be assigned to this Search Service.
	Tags pulumi.StringMapInput
}

func (ServiceState) ElementType 

func (ServiceState) ElementType() reflect.Type

type SharedPrivateLinkService added in v5.18.0 

type SharedPrivateLinkService struct {
	pulumi.CustomResourceState

	// Specify the name of the Azure Search Shared Private Link Resource. Changing this forces a new resource to be created.
	Name pulumi.StringOutput `pulumi:"name"`
	// Specify the request message for requesting approval of the Shared Private Link Enabled Remote Resource.
	RequestMessage pulumi.StringPtrOutput `pulumi:"requestMessage"`
	// Specify the id of the Azure Search Service. Changing this forces a new resource to be created.
	SearchServiceId pulumi.StringOutput `pulumi:"searchServiceId"`
	// The status of a private endpoint connection. Possible values are Pending, Approved, Rejected or Disconnected.
	Status pulumi.StringOutput `pulumi:"status"`
	// Specify the sub resource name which the Azure Search Private Endpoint is able to connect to. Changing this forces a new resource to be created.
	SubresourceName pulumi.StringOutput `pulumi:"subresourceName"`
	// Specify the ID of the Shared Private Link Enabled Remote Resource which this Azure Search Private Endpoint should be connected to. Changing this forces a new resource to be created.
	//
	// > **NOTE:** The sub resource name should match with the type of the target resource id that's being specified.
	TargetResourceId pulumi.StringOutput `pulumi:"targetResourceId"`
}

Manages the Shared Private Link Service for an Azure Search Service.

## Example Usage

```go 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-azure/sdk/v5/go/azure/storage"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		test, err := core.NewResourceGroup(ctx, "test", &core.ResourceGroupArgs{
			Name:     pulumi.String("example-resourceGroup"),
			Location: pulumi.String("east us"),
		})
		if err != nil {
			return err
		}
		testService, err := search.NewService(ctx, "test", &search.ServiceArgs{
			Name:              pulumi.String("example-search"),
			ResourceGroupName: test.Name,
			Location:          test.Location,
			Sku:               pulumi.String("standard"),
		})
		if err != nil {
			return err
		}
		testAccount, err := storage.NewAccount(ctx, "test", &storage.AccountArgs{
			Name:                   pulumi.String("xiaxintestsaforsearchspl"),
			ResourceGroupName:      test.Name,
			Location:               test.Location,
			AccountTier:            pulumi.String("Standard"),
			AccountReplicationType: pulumi.String("LRS"),
		})
		if err != nil {
			return err
		}
		_, err = search.NewSharedPrivateLinkService(ctx, "test", &search.SharedPrivateLinkServiceArgs{
			Name:             pulumi.String("example-spl"),
			SearchServiceId:  testService.ID(),
			SubresourceName:  pulumi.String("blob"),
			TargetResourceId: testAccount.ID(),
			RequestMessage:   pulumi.String("please approve"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

Azure Search Shared Private Link Resource can be imported using the `resource id`, e.g.

```sh $ pulumi import azure:search/sharedPrivateLinkService:SharedPrivateLinkService example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.Search/searchServices/service1/sharedPrivateLinkResources/resource1 ```

func GetSharedPrivateLinkService added in v5.18.0 

func GetSharedPrivateLinkService(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *SharedPrivateLinkServiceState, opts ...pulumi.ResourceOption) (*SharedPrivateLinkService, error)

GetSharedPrivateLinkService gets an existing SharedPrivateLinkService resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewSharedPrivateLinkService added in v5.18.0 

func NewSharedPrivateLinkService(ctx *pulumi.Context,
	name string, args *SharedPrivateLinkServiceArgs, opts ...pulumi.ResourceOption) (*SharedPrivateLinkService, error)

NewSharedPrivateLinkService registers a new resource with the given unique name, arguments, and options.

func (*SharedPrivateLinkService) ElementType added in v5.18.0 

func (*SharedPrivateLinkService) ElementType() reflect.Type

func (*SharedPrivateLinkService) ToSharedPrivateLinkServiceOutput added in v5.18.0 

func (i *SharedPrivateLinkService) ToSharedPrivateLinkServiceOutput() SharedPrivateLinkServiceOutput

func (*SharedPrivateLinkService) ToSharedPrivateLinkServiceOutputWithContext added in v5.18.0 

func (i *SharedPrivateLinkService) ToSharedPrivateLinkServiceOutputWithContext(ctx context.Context) SharedPrivateLinkServiceOutput

type SharedPrivateLinkServiceArgs added in v5.18.0 

type SharedPrivateLinkServiceArgs struct {
	// Specify the name of the Azure Search Shared Private Link Resource. Changing this forces a new resource to be created.
	Name pulumi.StringPtrInput
	// Specify the request message for requesting approval of the Shared Private Link Enabled Remote Resource.
	RequestMessage pulumi.StringPtrInput
	// Specify the id of the Azure Search Service. Changing this forces a new resource to be created.
	SearchServiceId pulumi.StringInput
	// Specify the sub resource name which the Azure Search Private Endpoint is able to connect to. Changing this forces a new resource to be created.
	SubresourceName pulumi.StringInput
	// Specify the ID of the Shared Private Link Enabled Remote Resource which this Azure Search Private Endpoint should be connected to. Changing this forces a new resource to be created.
	//
	// > **NOTE:** The sub resource name should match with the type of the target resource id that's being specified.
	TargetResourceId pulumi.StringInput
}

The set of arguments for constructing a SharedPrivateLinkService resource.

func (SharedPrivateLinkServiceArgs) ElementType added in v5.18.0 

func (SharedPrivateLinkServiceArgs) ElementType() reflect.Type

type SharedPrivateLinkServiceArray added in v5.18.0 

type SharedPrivateLinkServiceArray []SharedPrivateLinkServiceInput

func (SharedPrivateLinkServiceArray) ElementType added in v5.18.0 

func (SharedPrivateLinkServiceArray) ElementType() reflect.Type

func (SharedPrivateLinkServiceArray) ToSharedPrivateLinkServiceArrayOutput added in v5.18.0 

func (i SharedPrivateLinkServiceArray) ToSharedPrivateLinkServiceArrayOutput() SharedPrivateLinkServiceArrayOutput

func (SharedPrivateLinkServiceArray) ToSharedPrivateLinkServiceArrayOutputWithContext added in v5.18.0 

func (i SharedPrivateLinkServiceArray) ToSharedPrivateLinkServiceArrayOutputWithContext(ctx context.Context) SharedPrivateLinkServiceArrayOutput

type SharedPrivateLinkServiceArrayInput added in v5.18.0 

type SharedPrivateLinkServiceArrayInput interface {
	pulumi.Input

	ToSharedPrivateLinkServiceArrayOutput() SharedPrivateLinkServiceArrayOutput
	ToSharedPrivateLinkServiceArrayOutputWithContext(context.Context) SharedPrivateLinkServiceArrayOutput
}

SharedPrivateLinkServiceArrayInput is an input type that accepts SharedPrivateLinkServiceArray and SharedPrivateLinkServiceArrayOutput values. You can construct a concrete instance of `SharedPrivateLinkServiceArrayInput` via: 

SharedPrivateLinkServiceArray{ SharedPrivateLinkServiceArgs{...} }

type SharedPrivateLinkServiceArrayOutput added in v5.18.0 

type SharedPrivateLinkServiceArrayOutput struct{ *pulumi.OutputState }

func (SharedPrivateLinkServiceArrayOutput) ElementType added in v5.18.0 

func (SharedPrivateLinkServiceArrayOutput) ElementType() reflect.Type

func (SharedPrivateLinkServiceArrayOutput) Index added in v5.18.0 

func (o SharedPrivateLinkServiceArrayOutput) Index(i pulumi.IntInput) SharedPrivateLinkServiceOutput

func (SharedPrivateLinkServiceArrayOutput) ToSharedPrivateLinkServiceArrayOutput added in v5.18.0 

func (o SharedPrivateLinkServiceArrayOutput) ToSharedPrivateLinkServiceArrayOutput() SharedPrivateLinkServiceArrayOutput

func (SharedPrivateLinkServiceArrayOutput) ToSharedPrivateLinkServiceArrayOutputWithContext added in v5.18.0 

func (o SharedPrivateLinkServiceArrayOutput) ToSharedPrivateLinkServiceArrayOutputWithContext(ctx context.Context) SharedPrivateLinkServiceArrayOutput

type SharedPrivateLinkServiceInput added in v5.18.0 

type SharedPrivateLinkServiceInput interface {
	pulumi.Input

	ToSharedPrivateLinkServiceOutput() SharedPrivateLinkServiceOutput
	ToSharedPrivateLinkServiceOutputWithContext(ctx context.Context) SharedPrivateLinkServiceOutput
}

type SharedPrivateLinkServiceMap added in v5.18.0 

type SharedPrivateLinkServiceMap map[string]SharedPrivateLinkServiceInput

func (SharedPrivateLinkServiceMap) ElementType added in v5.18.0 

func (SharedPrivateLinkServiceMap) ElementType() reflect.Type

func (SharedPrivateLinkServiceMap) ToSharedPrivateLinkServiceMapOutput added in v5.18.0 

func (i SharedPrivateLinkServiceMap) ToSharedPrivateLinkServiceMapOutput() SharedPrivateLinkServiceMapOutput

func (SharedPrivateLinkServiceMap) ToSharedPrivateLinkServiceMapOutputWithContext added in v5.18.0 

func (i SharedPrivateLinkServiceMap) ToSharedPrivateLinkServiceMapOutputWithContext(ctx context.Context) SharedPrivateLinkServiceMapOutput

type SharedPrivateLinkServiceMapInput added in v5.18.0 

type SharedPrivateLinkServiceMapInput interface {
	pulumi.Input

	ToSharedPrivateLinkServiceMapOutput() SharedPrivateLinkServiceMapOutput
	ToSharedPrivateLinkServiceMapOutputWithContext(context.Context) SharedPrivateLinkServiceMapOutput
}

SharedPrivateLinkServiceMapInput is an input type that accepts SharedPrivateLinkServiceMap and SharedPrivateLinkServiceMapOutput values. You can construct a concrete instance of `SharedPrivateLinkServiceMapInput` via: 

SharedPrivateLinkServiceMap{ "key": SharedPrivateLinkServiceArgs{...} }

type SharedPrivateLinkServiceMapOutput added in v5.18.0 

type SharedPrivateLinkServiceMapOutput struct{ *pulumi.OutputState }

func (SharedPrivateLinkServiceMapOutput) ElementType added in v5.18.0 

func (SharedPrivateLinkServiceMapOutput) ElementType() reflect.Type

func (SharedPrivateLinkServiceMapOutput) MapIndex added in v5.18.0 

func (o SharedPrivateLinkServiceMapOutput) MapIndex(k pulumi.StringInput) SharedPrivateLinkServiceOutput

func (SharedPrivateLinkServiceMapOutput) ToSharedPrivateLinkServiceMapOutput added in v5.18.0 

func (o SharedPrivateLinkServiceMapOutput) ToSharedPrivateLinkServiceMapOutput() SharedPrivateLinkServiceMapOutput

func (SharedPrivateLinkServiceMapOutput) ToSharedPrivateLinkServiceMapOutputWithContext added in v5.18.0 

func (o SharedPrivateLinkServiceMapOutput) ToSharedPrivateLinkServiceMapOutputWithContext(ctx context.Context) SharedPrivateLinkServiceMapOutput

type SharedPrivateLinkServiceOutput added in v5.18.0 

type SharedPrivateLinkServiceOutput struct{ *pulumi.OutputState }

func (SharedPrivateLinkServiceOutput) ElementType added in v5.18.0 

func (SharedPrivateLinkServiceOutput) ElementType() reflect.Type

func (SharedPrivateLinkServiceOutput) Name added in v5.18.0 

func (o SharedPrivateLinkServiceOutput) Name() pulumi.StringOutput

Specify the name of the Azure Search Shared Private Link Resource. Changing this forces a new resource to be created.

func (SharedPrivateLinkServiceOutput) RequestMessage added in v5.18.0 

func (o SharedPrivateLinkServiceOutput) RequestMessage() pulumi.StringPtrOutput

Specify the request message for requesting approval of the Shared Private Link Enabled Remote Resource.

func (SharedPrivateLinkServiceOutput) SearchServiceId added in v5.18.0 

func (o SharedPrivateLinkServiceOutput) SearchServiceId() pulumi.StringOutput

Specify the id of the Azure Search Service. Changing this forces a new resource to be created.

func (SharedPrivateLinkServiceOutput) Status added in v5.18.0 

func (o SharedPrivateLinkServiceOutput) Status() pulumi.StringOutput

The status of a private endpoint connection. Possible values are Pending, Approved, Rejected or Disconnected.

func (SharedPrivateLinkServiceOutput) SubresourceName added in v5.18.0 

func (o SharedPrivateLinkServiceOutput) SubresourceName() pulumi.StringOutput

Specify the sub resource name which the Azure Search Private Endpoint is able to connect to. Changing this forces a new resource to be created.

func (SharedPrivateLinkServiceOutput) TargetResourceId added in v5.18.0 

func (o SharedPrivateLinkServiceOutput) TargetResourceId() pulumi.StringOutput

Specify the ID of the Shared Private Link Enabled Remote Resource which this Azure Search Private Endpoint should be connected to. Changing this forces a new resource to be created.

> **NOTE:** The sub resource name should match with the type of the target resource id that's being specified.

func (SharedPrivateLinkServiceOutput) ToSharedPrivateLinkServiceOutput added in v5.18.0 

func (o SharedPrivateLinkServiceOutput) ToSharedPrivateLinkServiceOutput() SharedPrivateLinkServiceOutput

func (SharedPrivateLinkServiceOutput) ToSharedPrivateLinkServiceOutputWithContext added in v5.18.0 

func (o SharedPrivateLinkServiceOutput) ToSharedPrivateLinkServiceOutputWithContext(ctx context.Context) SharedPrivateLinkServiceOutput

type SharedPrivateLinkServiceState added in v5.18.0 

type SharedPrivateLinkServiceState struct {
	// Specify the name of the Azure Search Shared Private Link Resource. Changing this forces a new resource to be created.
	Name pulumi.StringPtrInput
	// Specify the request message for requesting approval of the Shared Private Link Enabled Remote Resource.
	RequestMessage pulumi.StringPtrInput
	// Specify the id of the Azure Search Service. Changing this forces a new resource to be created.
	SearchServiceId pulumi.StringPtrInput
	// The status of a private endpoint connection. Possible values are Pending, Approved, Rejected or Disconnected.
	Status pulumi.StringPtrInput
	// Specify the sub resource name which the Azure Search Private Endpoint is able to connect to. Changing this forces a new resource to be created.
	SubresourceName pulumi.StringPtrInput
	// Specify the ID of the Shared Private Link Enabled Remote Resource which this Azure Search Private Endpoint should be connected to. Changing this forces a new resource to be created.
	//
	// > **NOTE:** The sub resource name should match with the type of the target resource id that's being specified.
	TargetResourceId pulumi.StringPtrInput
}

func (SharedPrivateLinkServiceState) ElementType added in v5.18.0 

func (SharedPrivateLinkServiceState) ElementType() reflect.Type

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.