Azure Classic v5.38.0, Mar 21 23

azure.search.SharedPrivateLinkService

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

Example Usage

using System.Collections.Generic;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var testResourceGroup = new Azure.Core.ResourceGroup("testResourceGroup", new()
    {
        Location = "east us",
    });

    var testService = new Azure.Search.Service("testService", new()
    {
        ResourceGroupName = testResourceGroup.Name,
        Location = testResourceGroup.Location,
        Sku = "standard",
    });

    var testAccount = new Azure.Storage.Account("testAccount", new()
    {
        ResourceGroupName = testResourceGroup.Name,
        Location = testResourceGroup.Location,
        AccountTier = "Standard",
        AccountReplicationType = "LRS",
    });

    var testSharedPrivateLinkService = new Azure.Search.SharedPrivateLinkService("testSharedPrivateLinkService", new()
    {
        SearchServiceId = testService.Id,
        SubresourceName = "blob",
        TargetResourceId = testAccount.Id,
        RequestMessage = "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 {
		testResourceGroup, err := core.NewResourceGroup(ctx, "testResourceGroup", &core.ResourceGroupArgs{
			Location: pulumi.String("east us"),
		})
		if err != nil {
			return err
		}
		testService, err := search.NewService(ctx, "testService", &search.ServiceArgs{
			ResourceGroupName: testResourceGroup.Name,
			Location:          testResourceGroup.Location,
			Sku:               pulumi.String("standard"),
		})
		if err != nil {
			return err
		}
		testAccount, err := storage.NewAccount(ctx, "testAccount", &storage.AccountArgs{
			ResourceGroupName:      testResourceGroup.Name,
			Location:               testResourceGroup.Location,
			AccountTier:            pulumi.String("Standard"),
			AccountReplicationType: pulumi.String("LRS"),
		})
		if err != nil {
			return err
		}
		_, err = search.NewSharedPrivateLinkService(ctx, "testSharedPrivateLinkService", &search.SharedPrivateLinkServiceArgs{
			SearchServiceId:  testService.ID(),
			SubresourceName:  pulumi.String("blob"),
			TargetResourceId: testAccount.ID(),
			RequestMessage:   pulumi.String("please approve"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.search.Service;
import com.pulumi.azure.search.ServiceArgs;
import 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 testResourceGroup = new ResourceGroup("testResourceGroup", ResourceGroupArgs.builder()        
            .location("east us")
            .build());

        var testService = new Service("testService", ServiceArgs.builder()        
            .resourceGroupName(testResourceGroup.name())
            .location(testResourceGroup.location())
            .sku("standard")
            .build());

        var testAccount = new Account("testAccount", AccountArgs.builder()        
            .resourceGroupName(testResourceGroup.name())
            .location(testResourceGroup.location())
            .accountTier("Standard")
            .accountReplicationType("LRS")
            .build());

        var testSharedPrivateLinkService = new SharedPrivateLinkService("testSharedPrivateLinkService", SharedPrivateLinkServiceArgs.builder()        
            .searchServiceId(testService.id())
            .subresourceName("blob")
            .targetResourceId(testAccount.id())
            .requestMessage("please approve")
            .build());

    }
}

import pulumi
import pulumi_azure as azure

test_resource_group = azure.core.ResourceGroup("testResourceGroup", location="east us")
test_service = azure.search.Service("testService",
    resource_group_name=test_resource_group.name,
    location=test_resource_group.location,
    sku="standard")
test_account = azure.storage.Account("testAccount",
    resource_group_name=test_resource_group.name,
    location=test_resource_group.location,
    account_tier="Standard",
    account_replication_type="LRS")
test_shared_private_link_service = azure.search.SharedPrivateLinkService("testSharedPrivateLinkService",
    search_service_id=test_service.id,
    subresource_name="blob",
    target_resource_id=test_account.id,
    request_message="please approve")

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const testResourceGroup = new azure.core.ResourceGroup("testResourceGroup", {location: "east us"});
const testService = new azure.search.Service("testService", {
    resourceGroupName: testResourceGroup.name,
    location: testResourceGroup.location,
    sku: "standard",
});
const testAccount = new azure.storage.Account("testAccount", {
    resourceGroupName: testResourceGroup.name,
    location: testResourceGroup.location,
    accountTier: "Standard",
    accountReplicationType: "LRS",
});
const testSharedPrivateLinkService = new azure.search.SharedPrivateLinkService("testSharedPrivateLinkService", {
    searchServiceId: testService.id,
    subresourceName: "blob",
    targetResourceId: testAccount.id,
    requestMessage: "please approve",
});

resources:
  testResourceGroup:
    type: azure:core:ResourceGroup
    properties:
      location: east us
  testService:
    type: azure:search:Service
    properties:
      resourceGroupName: ${testResourceGroup.name}
      location: ${testResourceGroup.location}
      sku: standard
  testAccount:
    type: azure:storage:Account
    properties:
      resourceGroupName: ${testResourceGroup.name}
      location: ${testResourceGroup.location}
      accountTier: Standard
      accountReplicationType: LRS
  testSharedPrivateLinkService:
    type: azure:search:SharedPrivateLinkService
    properties:
      searchServiceId: ${testService.id}
      subresourceName: blob
      targetResourceId: ${testAccount.id}
      requestMessage: please approve

Create SharedPrivateLinkService Resource

new SharedPrivateLinkService(name: string, args: SharedPrivateLinkServiceArgs, opts?: CustomResourceOptions);

@overload
def SharedPrivateLinkService(resource_name: str,
                             opts: Optional[ResourceOptions] = None,
                             name: Optional[str] = None,
                             request_message: Optional[str] = None,
                             search_service_id: Optional[str] = None,
                             subresource_name: Optional[str] = None,
                             target_resource_id: Optional[str] = None)
@overload
def SharedPrivateLinkService(resource_name: str,
                             args: SharedPrivateLinkServiceArgs,
                             opts: Optional[ResourceOptions] = 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.

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.

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

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.

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.

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.

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.

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.

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

Package Details

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