1. Packages
  2. Azure Native
  3. API Docs
  4. search
  5. SharedPrivateLinkResource
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.33.0 published on Friday, Mar 22, 2024 by Pulumi

azure-native.search.SharedPrivateLinkResource

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.33.0 published on Friday, Mar 22, 2024 by Pulumi

    Describes a Shared Private Link Resource managed by the Azure Cognitive Search service. Azure REST API version: 2022-09-01. Prior API version in Azure Native 1.x: 2020-08-01.

    Other available API versions: 2023-11-01, 2024-03-01-preview.

    Example Usage

    SharedPrivateLinkResourceCreateOrUpdate

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AzureNative = Pulumi.AzureNative;
    
    return await Deployment.RunAsync(() => 
    {
        var sharedPrivateLinkResource = new AzureNative.Search.SharedPrivateLinkResource("sharedPrivateLinkResource", new()
        {
            Properties = new AzureNative.Search.Inputs.SharedPrivateLinkResourcePropertiesArgs
            {
                GroupId = "blob",
                PrivateLinkResourceId = "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/storageAccountName",
                RequestMessage = "please approve",
            },
            ResourceGroupName = "rg1",
            SearchServiceName = "mysearchservice",
            SharedPrivateLinkResourceName = "testResource",
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure-native-sdk/search/v2"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := search.NewSharedPrivateLinkResource(ctx, "sharedPrivateLinkResource", &search.SharedPrivateLinkResourceArgs{
    			Properties: &search.SharedPrivateLinkResourcePropertiesArgs{
    				GroupId:               pulumi.String("blob"),
    				PrivateLinkResourceId: pulumi.String("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/storageAccountName"),
    				RequestMessage:        pulumi.String("please approve"),
    			},
    			ResourceGroupName:             pulumi.String("rg1"),
    			SearchServiceName:             pulumi.String("mysearchservice"),
    			SharedPrivateLinkResourceName: pulumi.String("testResource"),
    		})
    		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.azurenative.search.SharedPrivateLinkResource;
    import com.pulumi.azurenative.search.SharedPrivateLinkResourceArgs;
    import com.pulumi.azurenative.search.inputs.SharedPrivateLinkResourcePropertiesArgs;
    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 sharedPrivateLinkResource = new SharedPrivateLinkResource("sharedPrivateLinkResource", SharedPrivateLinkResourceArgs.builder()        
                .properties(SharedPrivateLinkResourcePropertiesArgs.builder()
                    .groupId("blob")
                    .privateLinkResourceId("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/storageAccountName")
                    .requestMessage("please approve")
                    .build())
                .resourceGroupName("rg1")
                .searchServiceName("mysearchservice")
                .sharedPrivateLinkResourceName("testResource")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_azure_native as azure_native
    
    shared_private_link_resource = azure_native.search.SharedPrivateLinkResource("sharedPrivateLinkResource",
        properties=azure_native.search.SharedPrivateLinkResourcePropertiesArgs(
            group_id="blob",
            private_link_resource_id="/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/storageAccountName",
            request_message="please approve",
        ),
        resource_group_name="rg1",
        search_service_name="mysearchservice",
        shared_private_link_resource_name="testResource")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure_native from "@pulumi/azure-native";
    
    const sharedPrivateLinkResource = new azure_native.search.SharedPrivateLinkResource("sharedPrivateLinkResource", {
        properties: {
            groupId: "blob",
            privateLinkResourceId: "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/storageAccountName",
            requestMessage: "please approve",
        },
        resourceGroupName: "rg1",
        searchServiceName: "mysearchservice",
        sharedPrivateLinkResourceName: "testResource",
    });
    
    resources:
      sharedPrivateLinkResource:
        type: azure-native:search:SharedPrivateLinkResource
        properties:
          properties:
            groupId: blob
            privateLinkResourceId: /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/storageAccountName
            requestMessage: please approve
          resourceGroupName: rg1
          searchServiceName: mysearchservice
          sharedPrivateLinkResourceName: testResource
    

    Create SharedPrivateLinkResource Resource

    new SharedPrivateLinkResource(name: string, args: SharedPrivateLinkResourceArgs, opts?: CustomResourceOptions);
    @overload
    def SharedPrivateLinkResource(resource_name: str,
                                  opts: Optional[ResourceOptions] = None,
                                  properties: Optional[SharedPrivateLinkResourcePropertiesArgs] = None,
                                  resource_group_name: Optional[str] = None,
                                  search_service_name: Optional[str] = None,
                                  shared_private_link_resource_name: Optional[str] = None)
    @overload
    def SharedPrivateLinkResource(resource_name: str,
                                  args: SharedPrivateLinkResourceArgs,
                                  opts: Optional[ResourceOptions] = None)
    func NewSharedPrivateLinkResource(ctx *Context, name string, args SharedPrivateLinkResourceArgs, opts ...ResourceOption) (*SharedPrivateLinkResource, error)
    public SharedPrivateLinkResource(string name, SharedPrivateLinkResourceArgs args, CustomResourceOptions? opts = null)
    public SharedPrivateLinkResource(String name, SharedPrivateLinkResourceArgs args)
    public SharedPrivateLinkResource(String name, SharedPrivateLinkResourceArgs args, CustomResourceOptions options)
    
    type: azure-native:search:SharedPrivateLinkResource
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args SharedPrivateLinkResourceArgs
    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 SharedPrivateLinkResourceArgs
    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 SharedPrivateLinkResourceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SharedPrivateLinkResourceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SharedPrivateLinkResourceArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

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

    ResourceGroupName string
    The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal.
    SearchServiceName string
    The name of the Azure Cognitive Search service associated with the specified resource group.
    Properties Pulumi.AzureNative.Search.Inputs.SharedPrivateLinkResourceProperties
    Describes the properties of a Shared Private Link Resource managed by the Azure Cognitive Search service.
    SharedPrivateLinkResourceName string
    The name of the shared private link resource managed by the Azure Cognitive Search service within the specified resource group.
    ResourceGroupName string
    The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal.
    SearchServiceName string
    The name of the Azure Cognitive Search service associated with the specified resource group.
    Properties SharedPrivateLinkResourcePropertiesArgs
    Describes the properties of a Shared Private Link Resource managed by the Azure Cognitive Search service.
    SharedPrivateLinkResourceName string
    The name of the shared private link resource managed by the Azure Cognitive Search service within the specified resource group.
    resourceGroupName String
    The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal.
    searchServiceName String
    The name of the Azure Cognitive Search service associated with the specified resource group.
    properties SharedPrivateLinkResourceProperties
    Describes the properties of a Shared Private Link Resource managed by the Azure Cognitive Search service.
    sharedPrivateLinkResourceName String
    The name of the shared private link resource managed by the Azure Cognitive Search service within the specified resource group.
    resourceGroupName string
    The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal.
    searchServiceName string
    The name of the Azure Cognitive Search service associated with the specified resource group.
    properties SharedPrivateLinkResourceProperties
    Describes the properties of a Shared Private Link Resource managed by the Azure Cognitive Search service.
    sharedPrivateLinkResourceName string
    The name of the shared private link resource managed by the Azure Cognitive Search service within the specified resource group.
    resource_group_name str
    The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal.
    search_service_name str
    The name of the Azure Cognitive Search service associated with the specified resource group.
    properties SharedPrivateLinkResourcePropertiesArgs
    Describes the properties of a Shared Private Link Resource managed by the Azure Cognitive Search service.
    shared_private_link_resource_name str
    The name of the shared private link resource managed by the Azure Cognitive Search service within the specified resource group.
    resourceGroupName String
    The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal.
    searchServiceName String
    The name of the Azure Cognitive Search service associated with the specified resource group.
    properties Property Map
    Describes the properties of a Shared Private Link Resource managed by the Azure Cognitive Search service.
    sharedPrivateLinkResourceName String
    The name of the shared private link resource managed by the Azure Cognitive Search service within the specified resource group.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the resource
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the resource
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the resource
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The name of the resource
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    The name of the resource
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the resource
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

    Supporting Types

    SharedPrivateLinkResourceProperties, SharedPrivateLinkResourcePropertiesArgs

    GroupId string
    The group id from the provider of resource the shared private link resource is for.
    PrivateLinkResourceId string
    The resource id of the resource the shared private link resource is for.
    ProvisioningState Pulumi.AzureNative.Search.SharedPrivateLinkResourceProvisioningState
    The provisioning state of the shared private link resource. Can be Updating, Deleting, Failed, Succeeded or Incomplete.
    RequestMessage string
    The request message for requesting approval of the shared private link resource.
    ResourceRegion string
    Optional. Can be used to specify the Azure Resource Manager location of the resource to which a shared private link is to be created. This is only required for those resources whose DNS configuration are regional (such as Azure Kubernetes Service).
    Status Pulumi.AzureNative.Search.SharedPrivateLinkResourceStatus
    Status of the shared private link resource. Can be Pending, Approved, Rejected or Disconnected.
    GroupId string
    The group id from the provider of resource the shared private link resource is for.
    PrivateLinkResourceId string
    The resource id of the resource the shared private link resource is for.
    ProvisioningState SharedPrivateLinkResourceProvisioningState
    The provisioning state of the shared private link resource. Can be Updating, Deleting, Failed, Succeeded or Incomplete.
    RequestMessage string
    The request message for requesting approval of the shared private link resource.
    ResourceRegion string
    Optional. Can be used to specify the Azure Resource Manager location of the resource to which a shared private link is to be created. This is only required for those resources whose DNS configuration are regional (such as Azure Kubernetes Service).
    Status SharedPrivateLinkResourceStatus
    Status of the shared private link resource. Can be Pending, Approved, Rejected or Disconnected.
    groupId String
    The group id from the provider of resource the shared private link resource is for.
    privateLinkResourceId String
    The resource id of the resource the shared private link resource is for.
    provisioningState SharedPrivateLinkResourceProvisioningState
    The provisioning state of the shared private link resource. Can be Updating, Deleting, Failed, Succeeded or Incomplete.
    requestMessage String
    The request message for requesting approval of the shared private link resource.
    resourceRegion String
    Optional. Can be used to specify the Azure Resource Manager location of the resource to which a shared private link is to be created. This is only required for those resources whose DNS configuration are regional (such as Azure Kubernetes Service).
    status SharedPrivateLinkResourceStatus
    Status of the shared private link resource. Can be Pending, Approved, Rejected or Disconnected.
    groupId string
    The group id from the provider of resource the shared private link resource is for.
    privateLinkResourceId string
    The resource id of the resource the shared private link resource is for.
    provisioningState SharedPrivateLinkResourceProvisioningState
    The provisioning state of the shared private link resource. Can be Updating, Deleting, Failed, Succeeded or Incomplete.
    requestMessage string
    The request message for requesting approval of the shared private link resource.
    resourceRegion string
    Optional. Can be used to specify the Azure Resource Manager location of the resource to which a shared private link is to be created. This is only required for those resources whose DNS configuration are regional (such as Azure Kubernetes Service).
    status SharedPrivateLinkResourceStatus
    Status of the shared private link resource. Can be Pending, Approved, Rejected or Disconnected.
    group_id str
    The group id from the provider of resource the shared private link resource is for.
    private_link_resource_id str
    The resource id of the resource the shared private link resource is for.
    provisioning_state SharedPrivateLinkResourceProvisioningState
    The provisioning state of the shared private link resource. Can be Updating, Deleting, Failed, Succeeded or Incomplete.
    request_message str
    The request message for requesting approval of the shared private link resource.
    resource_region str
    Optional. Can be used to specify the Azure Resource Manager location of the resource to which a shared private link is to be created. This is only required for those resources whose DNS configuration are regional (such as Azure Kubernetes Service).
    status SharedPrivateLinkResourceStatus
    Status of the shared private link resource. Can be Pending, Approved, Rejected or Disconnected.
    groupId String
    The group id from the provider of resource the shared private link resource is for.
    privateLinkResourceId String
    The resource id of the resource the shared private link resource is for.
    provisioningState "Updating" | "Deleting" | "Failed" | "Succeeded" | "Incomplete"
    The provisioning state of the shared private link resource. Can be Updating, Deleting, Failed, Succeeded or Incomplete.
    requestMessage String
    The request message for requesting approval of the shared private link resource.
    resourceRegion String
    Optional. Can be used to specify the Azure Resource Manager location of the resource to which a shared private link is to be created. This is only required for those resources whose DNS configuration are regional (such as Azure Kubernetes Service).
    status "Pending" | "Approved" | "Rejected" | "Disconnected"
    Status of the shared private link resource. Can be Pending, Approved, Rejected or Disconnected.

    SharedPrivateLinkResourcePropertiesResponse, SharedPrivateLinkResourcePropertiesResponseArgs

    GroupId string
    The group id from the provider of resource the shared private link resource is for.
    PrivateLinkResourceId string
    The resource id of the resource the shared private link resource is for.
    ProvisioningState string
    The provisioning state of the shared private link resource. Can be Updating, Deleting, Failed, Succeeded or Incomplete.
    RequestMessage string
    The request message for requesting approval of the shared private link resource.
    ResourceRegion string
    Optional. Can be used to specify the Azure Resource Manager location of the resource to which a shared private link is to be created. This is only required for those resources whose DNS configuration are regional (such as Azure Kubernetes Service).
    Status string
    Status of the shared private link resource. Can be Pending, Approved, Rejected or Disconnected.
    GroupId string
    The group id from the provider of resource the shared private link resource is for.
    PrivateLinkResourceId string
    The resource id of the resource the shared private link resource is for.
    ProvisioningState string
    The provisioning state of the shared private link resource. Can be Updating, Deleting, Failed, Succeeded or Incomplete.
    RequestMessage string
    The request message for requesting approval of the shared private link resource.
    ResourceRegion string
    Optional. Can be used to specify the Azure Resource Manager location of the resource to which a shared private link is to be created. This is only required for those resources whose DNS configuration are regional (such as Azure Kubernetes Service).
    Status string
    Status of the shared private link resource. Can be Pending, Approved, Rejected or Disconnected.
    groupId String
    The group id from the provider of resource the shared private link resource is for.
    privateLinkResourceId String
    The resource id of the resource the shared private link resource is for.
    provisioningState String
    The provisioning state of the shared private link resource. Can be Updating, Deleting, Failed, Succeeded or Incomplete.
    requestMessage String
    The request message for requesting approval of the shared private link resource.
    resourceRegion String
    Optional. Can be used to specify the Azure Resource Manager location of the resource to which a shared private link is to be created. This is only required for those resources whose DNS configuration are regional (such as Azure Kubernetes Service).
    status String
    Status of the shared private link resource. Can be Pending, Approved, Rejected or Disconnected.
    groupId string
    The group id from the provider of resource the shared private link resource is for.
    privateLinkResourceId string
    The resource id of the resource the shared private link resource is for.
    provisioningState string
    The provisioning state of the shared private link resource. Can be Updating, Deleting, Failed, Succeeded or Incomplete.
    requestMessage string
    The request message for requesting approval of the shared private link resource.
    resourceRegion string
    Optional. Can be used to specify the Azure Resource Manager location of the resource to which a shared private link is to be created. This is only required for those resources whose DNS configuration are regional (such as Azure Kubernetes Service).
    status string
    Status of the shared private link resource. Can be Pending, Approved, Rejected or Disconnected.
    group_id str
    The group id from the provider of resource the shared private link resource is for.
    private_link_resource_id str
    The resource id of the resource the shared private link resource is for.
    provisioning_state str
    The provisioning state of the shared private link resource. Can be Updating, Deleting, Failed, Succeeded or Incomplete.
    request_message str
    The request message for requesting approval of the shared private link resource.
    resource_region str
    Optional. Can be used to specify the Azure Resource Manager location of the resource to which a shared private link is to be created. This is only required for those resources whose DNS configuration are regional (such as Azure Kubernetes Service).
    status str
    Status of the shared private link resource. Can be Pending, Approved, Rejected or Disconnected.
    groupId String
    The group id from the provider of resource the shared private link resource is for.
    privateLinkResourceId String
    The resource id of the resource the shared private link resource is for.
    provisioningState String
    The provisioning state of the shared private link resource. Can be Updating, Deleting, Failed, Succeeded or Incomplete.
    requestMessage String
    The request message for requesting approval of the shared private link resource.
    resourceRegion String
    Optional. Can be used to specify the Azure Resource Manager location of the resource to which a shared private link is to be created. This is only required for those resources whose DNS configuration are regional (such as Azure Kubernetes Service).
    status String
    Status of the shared private link resource. Can be Pending, Approved, Rejected or Disconnected.

    SharedPrivateLinkResourceProvisioningState, SharedPrivateLinkResourceProvisioningStateArgs

    Updating
    Updating
    Deleting
    Deleting
    Failed
    Failed
    Succeeded
    Succeeded
    Incomplete
    Incomplete
    SharedPrivateLinkResourceProvisioningStateUpdating
    Updating
    SharedPrivateLinkResourceProvisioningStateDeleting
    Deleting
    SharedPrivateLinkResourceProvisioningStateFailed
    Failed
    SharedPrivateLinkResourceProvisioningStateSucceeded
    Succeeded
    SharedPrivateLinkResourceProvisioningStateIncomplete
    Incomplete
    Updating
    Updating
    Deleting
    Deleting
    Failed
    Failed
    Succeeded
    Succeeded
    Incomplete
    Incomplete
    Updating
    Updating
    Deleting
    Deleting
    Failed
    Failed
    Succeeded
    Succeeded
    Incomplete
    Incomplete
    UPDATING
    Updating
    DELETING
    Deleting
    FAILED
    Failed
    SUCCEEDED
    Succeeded
    INCOMPLETE
    Incomplete
    "Updating"
    Updating
    "Deleting"
    Deleting
    "Failed"
    Failed
    "Succeeded"
    Succeeded
    "Incomplete"
    Incomplete

    SharedPrivateLinkResourceStatus, SharedPrivateLinkResourceStatusArgs

    Pending
    Pending
    Approved
    Approved
    Rejected
    Rejected
    Disconnected
    Disconnected
    SharedPrivateLinkResourceStatusPending
    Pending
    SharedPrivateLinkResourceStatusApproved
    Approved
    SharedPrivateLinkResourceStatusRejected
    Rejected
    SharedPrivateLinkResourceStatusDisconnected
    Disconnected
    Pending
    Pending
    Approved
    Approved
    Rejected
    Rejected
    Disconnected
    Disconnected
    Pending
    Pending
    Approved
    Approved
    Rejected
    Rejected
    Disconnected
    Disconnected
    PENDING
    Pending
    APPROVED
    Approved
    REJECTED
    Rejected
    DISCONNECTED
    Disconnected
    "Pending"
    Pending
    "Approved"
    Approved
    "Rejected"
    Rejected
    "Disconnected"
    Disconnected

    Import

    An existing resource can be imported using its type token, name, and identifier, e.g.

    $ pulumi import azure-native:search:SharedPrivateLinkResource testResource /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/sharedPrivateLinkResources/{sharedPrivateLinkResourceName} 
    

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.33.0 published on Friday, Mar 22, 2024 by Pulumi