1. Packages
  2. Azure Classic
  3. API Docs
  4. search
  5. SharedPrivateLinkService

We recommend using Azure Native.

Azure Classic v5.85.0 published on Tuesday, Jul 23, 2024 by Pulumi

azure.search.SharedPrivateLinkService

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.85.0 published on Tuesday, Jul 23, 2024 by Pulumi

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

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as azure from "@pulumi/azure";
    
    const test = new azure.core.ResourceGroup("test", {
        name: "example-resourceGroup",
        location: "east us",
    });
    const testService = new azure.search.Service("test", {
        name: "example-search",
        resourceGroupName: test.name,
        location: test.location,
        sku: "standard",
    });
    const testAccount = new azure.storage.Account("test", {
        name: "xiaxintestsaforsearchspl",
        resourceGroupName: test.name,
        location: test.location,
        accountTier: "Standard",
        accountReplicationType: "LRS",
    });
    const testSharedPrivateLinkService = new azure.search.SharedPrivateLinkService("test", {
        name: "example-spl",
        searchServiceId: testService.id,
        subresourceName: "blob",
        targetResourceId: testAccount.id,
        requestMessage: "please approve",
    });
    
    import pulumi
    import pulumi_azure as azure
    
    test = azure.core.ResourceGroup("test",
        name="example-resourceGroup",
        location="east us")
    test_service = azure.search.Service("test",
        name="example-search",
        resource_group_name=test.name,
        location=test.location,
        sku="standard")
    test_account = azure.storage.Account("test",
        name="xiaxintestsaforsearchspl",
        resource_group_name=test.name,
        location=test.location,
        account_tier="Standard",
        account_replication_type="LRS")
    test_shared_private_link_service = azure.search.SharedPrivateLinkService("test",
        name="example-spl",
        search_service_id=test_service.id,
        subresource_name="blob",
        target_resource_id=test_account.id,
        request_message="please approve")
    
    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
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Azure = Pulumi.Azure;
    
    return await Deployment.RunAsync(() => 
    {
        var test = new Azure.Core.ResourceGroup("test", new()
        {
            Name = "example-resourceGroup",
            Location = "east us",
        });
    
        var testService = new Azure.Search.Service("test", new()
        {
            Name = "example-search",
            ResourceGroupName = test.Name,
            Location = test.Location,
            Sku = "standard",
        });
    
        var testAccount = new Azure.Storage.Account("test", new()
        {
            Name = "xiaxintestsaforsearchspl",
            ResourceGroupName = test.Name,
            Location = test.Location,
            AccountTier = "Standard",
            AccountReplicationType = "LRS",
        });
    
        var testSharedPrivateLinkService = new Azure.Search.SharedPrivateLinkService("test", new()
        {
            Name = "example-spl",
            SearchServiceId = testService.Id,
            SubresourceName = "blob",
            TargetResourceId = testAccount.Id,
            RequestMessage = "please approve",
        });
    
    });
    
    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 com.pulumi.azure.storage.Account;
    import com.pulumi.azure.storage.AccountArgs;
    import com.pulumi.azure.search.SharedPrivateLinkService;
    import com.pulumi.azure.search.SharedPrivateLinkServiceArgs;
    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 test = new ResourceGroup("test", ResourceGroupArgs.builder()
                .name("example-resourceGroup")
                .location("east us")
                .build());
    
            var testService = new Service("testService", ServiceArgs.builder()
                .name("example-search")
                .resourceGroupName(test.name())
                .location(test.location())
                .sku("standard")
                .build());
    
            var testAccount = new Account("testAccount", AccountArgs.builder()
                .name("xiaxintestsaforsearchspl")
                .resourceGroupName(test.name())
                .location(test.location())
                .accountTier("Standard")
                .accountReplicationType("LRS")
                .build());
    
            var testSharedPrivateLinkService = new SharedPrivateLinkService("testSharedPrivateLinkService", SharedPrivateLinkServiceArgs.builder()
                .name("example-spl")
                .searchServiceId(testService.id())
                .subresourceName("blob")
                .targetResourceId(testAccount.id())
                .requestMessage("please approve")
                .build());
    
        }
    }
    
    resources:
      test:
        type: azure:core:ResourceGroup
        properties:
          name: example-resourceGroup
          location: east us
      testService:
        type: azure:search:Service
        name: test
        properties:
          name: example-search
          resourceGroupName: ${test.name}
          location: ${test.location}
          sku: standard
      testAccount:
        type: azure:storage:Account
        name: test
        properties:
          name: xiaxintestsaforsearchspl
          resourceGroupName: ${test.name}
          location: ${test.location}
          accountTier: Standard
          accountReplicationType: LRS
      testSharedPrivateLinkService:
        type: azure:search:SharedPrivateLinkService
        name: test
        properties:
          name: example-spl
          searchServiceId: ${testService.id}
          subresourceName: blob
          targetResourceId: ${testAccount.id}
          requestMessage: please approve
    

    Create SharedPrivateLinkService Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new SharedPrivateLinkService(name: string, args: SharedPrivateLinkServiceArgs, opts?: CustomResourceOptions);
    @overload
    def SharedPrivateLinkService(resource_name: str,
                                 args: SharedPrivateLinkServiceArgs,
                                 opts: Optional[ResourceOptions] = None)
    
    @overload
    def SharedPrivateLinkService(resource_name: str,
                                 opts: Optional[ResourceOptions] = None,
                                 search_service_id: Optional[str] = None,
                                 subresource_name: Optional[str] = None,
                                 target_resource_id: Optional[str] = None,
                                 name: Optional[str] = None,
                                 request_message: Optional[str] = None)
    func NewSharedPrivateLinkService(ctx *Context, name string, args SharedPrivateLinkServiceArgs, opts ...ResourceOption) (*SharedPrivateLinkService, error)
    public SharedPrivateLinkService(string name, SharedPrivateLinkServiceArgs args, CustomResourceOptions? opts = null)
    public SharedPrivateLinkService(String name, SharedPrivateLinkServiceArgs args)
    public SharedPrivateLinkService(String name, SharedPrivateLinkServiceArgs args, CustomResourceOptions options)
    
    type: azure:search:SharedPrivateLinkService
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args SharedPrivateLinkServiceArgs
    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 SharedPrivateLinkServiceArgs
    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 SharedPrivateLinkServiceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SharedPrivateLinkServiceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SharedPrivateLinkServiceArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var sharedPrivateLinkServiceResource = new Azure.Search.SharedPrivateLinkService("sharedPrivateLinkServiceResource", new()
    {
        SearchServiceId = "string",
        SubresourceName = "string",
        TargetResourceId = "string",
        Name = "string",
        RequestMessage = "string",
    });
    
    example, err := search.NewSharedPrivateLinkService(ctx, "sharedPrivateLinkServiceResource", &search.SharedPrivateLinkServiceArgs{
    	SearchServiceId:  pulumi.String("string"),
    	SubresourceName:  pulumi.String("string"),
    	TargetResourceId: pulumi.String("string"),
    	Name:             pulumi.String("string"),
    	RequestMessage:   pulumi.String("string"),
    })
    
    var sharedPrivateLinkServiceResource = new SharedPrivateLinkService("sharedPrivateLinkServiceResource", SharedPrivateLinkServiceArgs.builder()
        .searchServiceId("string")
        .subresourceName("string")
        .targetResourceId("string")
        .name("string")
        .requestMessage("string")
        .build());
    
    shared_private_link_service_resource = azure.search.SharedPrivateLinkService("sharedPrivateLinkServiceResource",
        search_service_id="string",
        subresource_name="string",
        target_resource_id="string",
        name="string",
        request_message="string")
    
    const sharedPrivateLinkServiceResource = new azure.search.SharedPrivateLinkService("sharedPrivateLinkServiceResource", {
        searchServiceId: "string",
        subresourceName: "string",
        targetResourceId: "string",
        name: "string",
        requestMessage: "string",
    });
    
    type: azure:search:SharedPrivateLinkService
    properties:
        name: string
        requestMessage: string
        searchServiceId: string
        subresourceName: string
        targetResourceId: string
    

    SharedPrivateLinkService 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 SharedPrivateLinkService resource accepts the following input properties:

    SearchServiceId string
    Specify the id of the Azure Search Service. Changing this forces a new resource to be created.
    SubresourceName string
    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.
    TargetResourceId string

    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.

    Name string
    Specify the name of the Azure Search Shared Private Link Resource. Changing this forces a new resource to be created.
    RequestMessage string
    Specify the request message for requesting approval of the Shared Private Link Enabled Remote Resource.
    SearchServiceId string
    Specify the id of the Azure Search Service. Changing this forces a new resource to be created.
    SubresourceName string
    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.
    TargetResourceId string

    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.

    Name string
    Specify the name of the Azure Search Shared Private Link Resource. Changing this forces a new resource to be created.
    RequestMessage string
    Specify the request message for requesting approval of the Shared Private Link Enabled Remote Resource.
    searchServiceId String
    Specify the id of the Azure Search Service. Changing this forces a new resource to be created.
    subresourceName String
    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.
    targetResourceId String

    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.

    name String
    Specify the name of the Azure Search Shared Private Link Resource. Changing this forces a new resource to be created.
    requestMessage String
    Specify the request message for requesting approval of the Shared Private Link Enabled Remote Resource.
    searchServiceId string
    Specify the id of the Azure Search Service. Changing this forces a new resource to be created.
    subresourceName string
    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.
    targetResourceId string

    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.

    name string
    Specify the name of the Azure Search Shared Private Link Resource. Changing this forces a new resource to be created.
    requestMessage string
    Specify the request message for requesting approval of the Shared Private Link Enabled Remote Resource.
    search_service_id str
    Specify the id of the Azure Search Service. Changing this forces a new resource to be created.
    subresource_name str
    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.
    target_resource_id str

    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.

    name str
    Specify the name of the Azure Search Shared Private Link Resource. Changing this forces a new resource to be created.
    request_message str
    Specify the request message for requesting approval of the Shared Private Link Enabled Remote Resource.
    searchServiceId String
    Specify the id of the Azure Search Service. Changing this forces a new resource to be created.
    subresourceName String
    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.
    targetResourceId String

    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.

    name String
    Specify the name of the Azure Search Shared Private Link Resource. Changing this forces a new resource to be created.
    requestMessage String
    Specify the request message for requesting approval of the Shared Private Link Enabled Remote Resource.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    The status of a private endpoint connection. Possible values are Pending, Approved, Rejected or Disconnected.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    The status of a private endpoint connection. Possible values are Pending, Approved, Rejected or Disconnected.
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    The status of a private endpoint connection. Possible values are Pending, Approved, Rejected or Disconnected.
    id string
    The provider-assigned unique ID for this managed resource.
    status string
    The status of a private endpoint connection. Possible values are Pending, Approved, Rejected or Disconnected.
    id str
    The provider-assigned unique ID for this managed resource.
    status str
    The status of a private endpoint connection. Possible values are Pending, Approved, Rejected or Disconnected.
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    The status of a private endpoint connection. Possible values are Pending, Approved, Rejected or Disconnected.

    Look up Existing SharedPrivateLinkService Resource

    Get an existing SharedPrivateLinkService 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?: SharedPrivateLinkServiceState, opts?: CustomResourceOptions): SharedPrivateLinkService
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            name: Optional[str] = None,
            request_message: Optional[str] = None,
            search_service_id: Optional[str] = None,
            status: Optional[str] = None,
            subresource_name: Optional[str] = None,
            target_resource_id: Optional[str] = None) -> SharedPrivateLinkService
    func GetSharedPrivateLinkService(ctx *Context, name string, id IDInput, state *SharedPrivateLinkServiceState, opts ...ResourceOption) (*SharedPrivateLinkService, error)
    public static SharedPrivateLinkService Get(string name, Input<string> id, SharedPrivateLinkServiceState? state, CustomResourceOptions? opts = null)
    public static SharedPrivateLinkService get(String name, Output<String> id, SharedPrivateLinkServiceState 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.
    The following state arguments are supported:
    Name string
    Specify the name of the Azure Search Shared Private Link Resource. Changing this forces a new resource to be created.
    RequestMessage string
    Specify the request message for requesting approval of the Shared Private Link Enabled Remote Resource.
    SearchServiceId string
    Specify the id of the Azure Search Service. Changing this forces a new resource to be created.
    Status string
    The status of a private endpoint connection. Possible values are Pending, Approved, Rejected or Disconnected.
    SubresourceName string
    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.
    TargetResourceId string

    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.

    Name string
    Specify the name of the Azure Search Shared Private Link Resource. Changing this forces a new resource to be created.
    RequestMessage string
    Specify the request message for requesting approval of the Shared Private Link Enabled Remote Resource.
    SearchServiceId string
    Specify the id of the Azure Search Service. Changing this forces a new resource to be created.
    Status string
    The status of a private endpoint connection. Possible values are Pending, Approved, Rejected or Disconnected.
    SubresourceName string
    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.
    TargetResourceId string

    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.

    name String
    Specify the name of the Azure Search Shared Private Link Resource. Changing this forces a new resource to be created.
    requestMessage String
    Specify the request message for requesting approval of the Shared Private Link Enabled Remote Resource.
    searchServiceId String
    Specify the id of the Azure Search Service. Changing this forces a new resource to be created.
    status String
    The status of a private endpoint connection. Possible values are Pending, Approved, Rejected or Disconnected.
    subresourceName String
    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.
    targetResourceId String

    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.

    name string
    Specify the name of the Azure Search Shared Private Link Resource. Changing this forces a new resource to be created.
    requestMessage string
    Specify the request message for requesting approval of the Shared Private Link Enabled Remote Resource.
    searchServiceId string
    Specify the id of the Azure Search Service. Changing this forces a new resource to be created.
    status string
    The status of a private endpoint connection. Possible values are Pending, Approved, Rejected or Disconnected.
    subresourceName string
    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.
    targetResourceId string

    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.

    name str
    Specify the name of the Azure Search Shared Private Link Resource. Changing this forces a new resource to be created.
    request_message str
    Specify the request message for requesting approval of the Shared Private Link Enabled Remote Resource.
    search_service_id str
    Specify the id of the Azure Search Service. Changing this forces a new resource to be created.
    status str
    The status of a private endpoint connection. Possible values are Pending, Approved, Rejected or Disconnected.
    subresource_name str
    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.
    target_resource_id str

    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.

    name String
    Specify the name of the Azure Search Shared Private Link Resource. Changing this forces a new resource to be created.
    requestMessage String
    Specify the request message for requesting approval of the Shared Private Link Enabled Remote Resource.
    searchServiceId String
    Specify the id of the Azure Search Service. Changing this forces a new resource to be created.
    status String
    The status of a private endpoint connection. Possible values are Pending, Approved, Rejected or Disconnected.
    subresourceName String
    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.
    targetResourceId String

    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.

    Import

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

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

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

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azurerm Terraform Provider.
    azure logo

    We recommend using Azure Native.

    Azure Classic v5.85.0 published on Tuesday, Jul 23, 2024 by Pulumi