Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. search
  5. getSharedPrivateLinkResource
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.search.getSharedPrivateLinkResource

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

Gets the details of the shared private link resource managed by the search service in the given resource group. Azure REST API version: 2022-09-01.

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

Using getSharedPrivateLinkResource

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getSharedPrivateLinkResource(args: GetSharedPrivateLinkResourceArgs, opts?: InvokeOptions): Promise<GetSharedPrivateLinkResourceResult>
function getSharedPrivateLinkResourceOutput(args: GetSharedPrivateLinkResourceOutputArgs, opts?: InvokeOptions): Output<GetSharedPrivateLinkResourceResult>
Copy
def get_shared_private_link_resource(resource_group_name: Optional[str] = None,
                                     search_service_name: Optional[str] = None,
                                     shared_private_link_resource_name: Optional[str] = None,
                                     opts: Optional[InvokeOptions] = None) -> GetSharedPrivateLinkResourceResult
def get_shared_private_link_resource_output(resource_group_name: Optional[pulumi.Input[str]] = None,
                                     search_service_name: Optional[pulumi.Input[str]] = None,
                                     shared_private_link_resource_name: Optional[pulumi.Input[str]] = None,
                                     opts: Optional[InvokeOptions] = None) -> Output[GetSharedPrivateLinkResourceResult]
Copy
func LookupSharedPrivateLinkResource(ctx *Context, args *LookupSharedPrivateLinkResourceArgs, opts ...InvokeOption) (*LookupSharedPrivateLinkResourceResult, error)
func LookupSharedPrivateLinkResourceOutput(ctx *Context, args *LookupSharedPrivateLinkResourceOutputArgs, opts ...InvokeOption) LookupSharedPrivateLinkResourceResultOutput
Copy

> Note: This function is named LookupSharedPrivateLinkResource in the Go SDK.

public static class GetSharedPrivateLinkResource 
{
    public static Task<GetSharedPrivateLinkResourceResult> InvokeAsync(GetSharedPrivateLinkResourceArgs args, InvokeOptions? opts = null)
    public static Output<GetSharedPrivateLinkResourceResult> Invoke(GetSharedPrivateLinkResourceInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetSharedPrivateLinkResourceResult> getSharedPrivateLinkResource(GetSharedPrivateLinkResourceArgs args, InvokeOptions options)
public static Output<GetSharedPrivateLinkResourceResult> getSharedPrivateLinkResource(GetSharedPrivateLinkResourceArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:search:getSharedPrivateLinkResource
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
string
The name of the Azure Cognitive Search service associated with the specified resource group.
SharedPrivateLinkResourceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the shared private link resource managed by the Azure Cognitive Search service within the specified resource group.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
string
The name of the Azure Cognitive Search service associated with the specified resource group.
SharedPrivateLinkResourceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the shared private link resource managed by the Azure Cognitive Search service within the specified resource group.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
String
The name of the Azure Cognitive Search service associated with the specified resource group.
sharedPrivateLinkResourceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the shared private link resource managed by the Azure Cognitive Search service within the specified resource group.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
string
The name of the Azure Cognitive Search service associated with the specified resource group.
sharedPrivateLinkResourceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the shared private link resource managed by the Azure Cognitive Search service within the specified resource group.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
str
The name of the Azure Cognitive Search service associated with the specified resource group.
shared_private_link_resource_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the shared private link resource managed by the Azure Cognitive Search service within the specified resource group.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
String
The name of the Azure Cognitive Search service associated with the specified resource group.
sharedPrivateLinkResourceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the shared private link resource managed by the Azure Cognitive Search service within the specified resource group.

getSharedPrivateLinkResource Result

The following output properties are available:

Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Name string
The name of the resource
Properties Pulumi.AzureNative.Search.Outputs.SharedPrivateLinkResourcePropertiesResponse
Describes the properties of a Shared Private Link Resource managed by the Azure Cognitive Search service.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Name string
The name of the resource
Properties SharedPrivateLinkResourcePropertiesResponse
Describes the properties of a Shared Private Link Resource managed by the Azure Cognitive Search service.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name String
The name of the resource
properties SharedPrivateLinkResourcePropertiesResponse
Describes the properties of a Shared Private Link Resource managed by the Azure Cognitive Search service.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name string
The name of the resource
properties SharedPrivateLinkResourcePropertiesResponse
Describes the properties of a Shared Private Link Resource managed by the Azure Cognitive Search service.
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
id str
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name str
The name of the resource
properties SharedPrivateLinkResourcePropertiesResponse
Describes the properties of a Shared Private Link Resource managed by the Azure Cognitive Search service.
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name String
The name of the resource
properties Property Map
Describes the properties of a Shared Private Link Resource managed by the Azure Cognitive Search service.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Supporting Types

SharedPrivateLinkResourcePropertiesResponse

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.

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native