azure-native.search.SharedPrivateLinkResource
Explore with Pulumi AI
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, 2024-06-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 (
search "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={
"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
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new SharedPrivateLinkResource(name: string, args: SharedPrivateLinkResourceArgs, opts?: CustomResourceOptions);
@overload
def SharedPrivateLinkResource(resource_name: str,
args: SharedPrivateLinkResourceArgs,
opts: Optional[ResourceOptions] = None)
@overload
def SharedPrivateLinkResource(resource_name: str,
opts: Optional[ResourceOptions] = None,
resource_group_name: Optional[str] = None,
search_service_name: Optional[str] = None,
properties: Optional[SharedPrivateLinkResourcePropertiesArgs] = None,
shared_private_link_resource_name: Optional[str] = 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.
Parameters
- 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.
Constructor example
The following reference example uses placeholder values for all input properties.
var azure_nativeSharedPrivateLinkResourceResource = new AzureNative.Search.SharedPrivateLinkResource("azure-nativeSharedPrivateLinkResourceResource", new()
{
ResourceGroupName = "string",
SearchServiceName = "string",
Properties = new AzureNative.Search.Inputs.SharedPrivateLinkResourcePropertiesArgs
{
GroupId = "string",
PrivateLinkResourceId = "string",
ProvisioningState = AzureNative.Search.SharedPrivateLinkResourceProvisioningState.Updating,
RequestMessage = "string",
ResourceRegion = "string",
Status = AzureNative.Search.SharedPrivateLinkResourceStatus.Pending,
},
SharedPrivateLinkResourceName = "string",
});
example, err := search.NewSharedPrivateLinkResource(ctx, "azure-nativeSharedPrivateLinkResourceResource", &search.SharedPrivateLinkResourceArgs{
ResourceGroupName: pulumi.String("string"),
SearchServiceName: pulumi.String("string"),
Properties: &search.SharedPrivateLinkResourcePropertiesArgs{
GroupId: pulumi.String("string"),
PrivateLinkResourceId: pulumi.String("string"),
ProvisioningState: search.SharedPrivateLinkResourceProvisioningStateUpdating,
RequestMessage: pulumi.String("string"),
ResourceRegion: pulumi.String("string"),
Status: search.SharedPrivateLinkResourceStatusPending,
},
SharedPrivateLinkResourceName: pulumi.String("string"),
})
var azure_nativeSharedPrivateLinkResourceResource = new SharedPrivateLinkResource("azure-nativeSharedPrivateLinkResourceResource", SharedPrivateLinkResourceArgs.builder()
.resourceGroupName("string")
.searchServiceName("string")
.properties(SharedPrivateLinkResourcePropertiesArgs.builder()
.groupId("string")
.privateLinkResourceId("string")
.provisioningState("Updating")
.requestMessage("string")
.resourceRegion("string")
.status("Pending")
.build())
.sharedPrivateLinkResourceName("string")
.build());
azure_native_shared_private_link_resource_resource = azure_native.search.SharedPrivateLinkResource("azure-nativeSharedPrivateLinkResourceResource",
resource_group_name="string",
search_service_name="string",
properties={
"groupId": "string",
"privateLinkResourceId": "string",
"provisioningState": azure_native.search.SharedPrivateLinkResourceProvisioningState.UPDATING,
"requestMessage": "string",
"resourceRegion": "string",
"status": azure_native.search.SharedPrivateLinkResourceStatus.PENDING,
},
shared_private_link_resource_name="string")
const azure_nativeSharedPrivateLinkResourceResource = new azure_native.search.SharedPrivateLinkResource("azure-nativeSharedPrivateLinkResourceResource", {
resourceGroupName: "string",
searchServiceName: "string",
properties: {
groupId: "string",
privateLinkResourceId: "string",
provisioningState: azure_native.search.SharedPrivateLinkResourceProvisioningState.Updating,
requestMessage: "string",
resourceRegion: "string",
status: azure_native.search.SharedPrivateLinkResourceStatus.Pending,
},
sharedPrivateLinkResourceName: "string",
});
type: azure-native:search:SharedPrivateLinkResource
properties:
properties:
groupId: string
privateLinkResourceId: string
provisioningState: Updating
requestMessage: string
resourceRegion: string
status: Pending
resourceGroupName: string
searchServiceName: string
sharedPrivateLinkResourceName: string
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:
- Resource
Group stringName - 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 stringName - The name of the Azure Cognitive Search service associated with the specified resource group.
- Properties
Pulumi.
Azure Native. Search. Inputs. Shared Private Link Resource Properties - Describes the properties of a Shared Private Link Resource managed by the Azure Cognitive Search service.
- string
- The name of the shared private link resource managed by the Azure Cognitive Search service within the specified resource group.
- Resource
Group stringName - 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 stringName - The name of the Azure Cognitive Search service associated with the specified resource group.
- Properties
Shared
Private Link Resource Properties Args - Describes the properties of a Shared Private Link Resource managed by the Azure Cognitive Search service.
- string
- The name of the shared private link resource managed by the Azure Cognitive Search service within the specified resource group.
- resource
Group StringName - 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 StringName - The name of the Azure Cognitive Search service associated with the specified resource group.
- properties
Shared
Private Link Resource Properties - Describes the properties of a Shared Private Link Resource managed by the Azure Cognitive Search service.
- String
- The name of the shared private link resource managed by the Azure Cognitive Search service within the specified resource group.
- resource
Group stringName - 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 stringName - The name of the Azure Cognitive Search service associated with the specified resource group.
- properties
Shared
Private Link Resource Properties - Describes the properties of a Shared Private Link Resource managed by the Azure Cognitive Search service.
- string
- The name of the shared private link resource managed by the Azure Cognitive Search service within the specified resource group.
- resource_
group_ strname - 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_ strname - The name of the Azure Cognitive Search service associated with the specified resource group.
- properties
Shared
Private Link Resource Properties Args - Describes the properties of a Shared Private Link Resource managed by the Azure Cognitive Search service.
- str
- The name of the shared private link resource managed by the Azure Cognitive Search service within the specified resource group.
- resource
Group StringName - 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 StringName - 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.
- 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:
Supporting Types
SharedPrivateLinkResourceProperties, SharedPrivateLinkResourcePropertiesArgs
- Group
Id string - The group id from the provider of resource the shared private link resource is for.
- Private
Link stringResource Id - The resource id of the resource the shared private link resource is for.
- Provisioning
State Pulumi.Azure Native. Search. Shared Private Link Resource Provisioning State - The provisioning state of the shared private link resource. Can be Updating, Deleting, Failed, Succeeded or Incomplete.
- Request
Message string - The request message for requesting approval of the shared private link resource.
- Resource
Region 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.
Azure Native. Search. Shared Private Link Resource Status - Status of the shared private link resource. Can be Pending, Approved, Rejected or Disconnected.
- Group
Id string - The group id from the provider of resource the shared private link resource is for.
- Private
Link stringResource Id - The resource id of the resource the shared private link resource is for.
- Provisioning
State SharedPrivate Link Resource Provisioning State - The provisioning state of the shared private link resource. Can be Updating, Deleting, Failed, Succeeded or Incomplete.
- Request
Message string - The request message for requesting approval of the shared private link resource.
- Resource
Region 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
Shared
Private Link Resource Status - Status of the shared private link resource. Can be Pending, Approved, Rejected or Disconnected.
- group
Id String - The group id from the provider of resource the shared private link resource is for.
- private
Link StringResource Id - The resource id of the resource the shared private link resource is for.
- provisioning
State SharedPrivate Link Resource Provisioning State - The provisioning state of the shared private link resource. Can be Updating, Deleting, Failed, Succeeded or Incomplete.
- request
Message String - The request message for requesting approval of the shared private link resource.
- resource
Region 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
Shared
Private Link Resource Status - Status of the shared private link resource. Can be Pending, Approved, Rejected or Disconnected.
- group
Id string - The group id from the provider of resource the shared private link resource is for.
- private
Link stringResource Id - The resource id of the resource the shared private link resource is for.
- provisioning
State SharedPrivate Link Resource Provisioning State - The provisioning state of the shared private link resource. Can be Updating, Deleting, Failed, Succeeded or Incomplete.
- request
Message string - The request message for requesting approval of the shared private link resource.
- resource
Region 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
Shared
Private Link Resource Status - 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_ strresource_ id - The resource id of the resource the shared private link resource is for.
- provisioning_
state SharedPrivate Link Resource Provisioning State - 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
Shared
Private Link Resource Status - Status of the shared private link resource. Can be Pending, Approved, Rejected or Disconnected.
- group
Id String - The group id from the provider of resource the shared private link resource is for.
- private
Link StringResource Id - The resource id of the resource the shared private link resource is for.
- provisioning
State "Updating" | "Deleting" | "Failed" | "Succeeded" | "Incomplete" - The provisioning state of the shared private link resource. Can be Updating, Deleting, Failed, Succeeded or Incomplete.
- request
Message String - The request message for requesting approval of the shared private link resource.
- resource
Region 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
- Group
Id string - The group id from the provider of resource the shared private link resource is for.
- Private
Link stringResource Id - The resource id of the resource the shared private link resource is for.
- Provisioning
State string - The provisioning state of the shared private link resource. Can be Updating, Deleting, Failed, Succeeded or Incomplete.
- Request
Message string - The request message for requesting approval of the shared private link resource.
- Resource
Region 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 string - The group id from the provider of resource the shared private link resource is for.
- Private
Link stringResource Id - The resource id of the resource the shared private link resource is for.
- Provisioning
State string - The provisioning state of the shared private link resource. Can be Updating, Deleting, Failed, Succeeded or Incomplete.
- Request
Message string - The request message for requesting approval of the shared private link resource.
- Resource
Region 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 String - The group id from the provider of resource the shared private link resource is for.
- private
Link StringResource Id - The resource id of the resource the shared private link resource is for.
- provisioning
State String - The provisioning state of the shared private link resource. Can be Updating, Deleting, Failed, Succeeded or Incomplete.
- request
Message String - The request message for requesting approval of the shared private link resource.
- resource
Region 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 string - The group id from the provider of resource the shared private link resource is for.
- private
Link stringResource Id - The resource id of the resource the shared private link resource is for.
- provisioning
State string - The provisioning state of the shared private link resource. Can be Updating, Deleting, Failed, Succeeded or Incomplete.
- request
Message string - The request message for requesting approval of the shared private link resource.
- resource
Region 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_ strresource_ id - 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.
- group
Id String - The group id from the provider of resource the shared private link resource is for.
- private
Link StringResource Id - The resource id of the resource the shared private link resource is for.
- provisioning
State String - The provisioning state of the shared private link resource. Can be Updating, Deleting, Failed, Succeeded or Incomplete.
- request
Message String - The request message for requesting approval of the shared private link resource.
- resource
Region 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
- Shared
Private Link Resource Provisioning State Updating - Updating
- Shared
Private Link Resource Provisioning State Deleting - Deleting
- Shared
Private Link Resource Provisioning State Failed - Failed
- Shared
Private Link Resource Provisioning State Succeeded - Succeeded
- Shared
Private Link Resource Provisioning State 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
- "Updating"
- Updating
- "Deleting"
- Deleting
- "Failed"
- Failed
- "Succeeded"
- Succeeded
- "Incomplete"
- Incomplete
SharedPrivateLinkResourceStatus, SharedPrivateLinkResourceStatusArgs
- Pending
- Pending
- Approved
- Approved
- Rejected
- Rejected
- Disconnected
- Disconnected
- Shared
Private Link Resource Status Pending - Pending
- Shared
Private Link Resource Status Approved - Approved
- Shared
Private Link Resource Status Rejected - Rejected
- Shared
Private Link Resource Status 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
- "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}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0