published on Friday, Mar 20, 2026 by Pulumi
published on Friday, Mar 20, 2026 by Pulumi
Gets the details of the shared private link resource managed by the search service in the given resource group.
Uses Azure REST API version 2025-05-01.
Other available API versions: 2022-09-01, 2023-11-01, 2024-03-01-preview, 2024-06-01-preview, 2025-02-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native search [ApiVersion]. See the version guide for details.
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>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]func LookupSharedPrivateLinkResource(ctx *Context, args *LookupSharedPrivateLinkResourceArgs, opts ...InvokeOption) (*LookupSharedPrivateLinkResourceResult, error)
func LookupSharedPrivateLinkResourceOutput(ctx *Context, args *LookupSharedPrivateLinkResourceOutputArgs, opts ...InvokeOption) LookupSharedPrivateLinkResourceResultOutput> 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)
}public static CompletableFuture<GetSharedPrivateLinkResourceResult> getSharedPrivateLinkResource(GetSharedPrivateLinkResourceArgs args, InvokeOptions options)
public static Output<GetSharedPrivateLinkResourceResult> getSharedPrivateLinkResource(GetSharedPrivateLinkResourceArgs args, InvokeOptions options)
fn::invoke:
function: azure-native:search:getSharedPrivateLinkResource
arguments:
# arguments dictionaryThe following arguments are supported:
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Search
Service stringName - The name of the Azure AI Search service associated with the specified resource group.
- string
- The name of the shared private link resource managed by the Azure AI Search service within the specified resource group.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Search
Service stringName - The name of the Azure AI Search service associated with the specified resource group.
- string
- The name of the shared private link resource managed by the Azure AI Search service within the specified resource group.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- search
Service StringName - The name of the Azure AI Search service associated with the specified resource group.
- String
- The name of the shared private link resource managed by the Azure AI Search service within the specified resource group.
- resource
Group stringName - The name of the resource group. The name is case insensitive.
- search
Service stringName - The name of the Azure AI Search service associated with the specified resource group.
- string
- The name of the shared private link resource managed by the Azure AI Search service within the specified resource group.
- resource_
group_ strname - The name of the resource group. The name is case insensitive.
- search_
service_ strname - The name of the Azure AI Search service associated with the specified resource group.
- str
- The name of the shared private link resource managed by the Azure AI Search service within the specified resource group.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- search
Service StringName - The name of the Azure AI Search service associated with the specified resource group.
- String
- The name of the shared private link resource managed by the Azure AI Search service within the specified resource group.
getSharedPrivateLinkResource Result
The following output properties are available:
- Azure
Api stringVersion - The Azure API version of the resource.
- Id string
- Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
- Name string
- The name of the resource
- Properties
Pulumi.
Azure Native. Search. Outputs. Shared Private Link Resource Properties Response - Describes the properties of a shared private link resource managed by the Azure AI Search service.
- System
Data Pulumi.Azure Native. Search. Outputs. System Data Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- Type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- Azure
Api stringVersion - The Azure API version of the resource.
- Id string
- Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
- Name string
- The name of the resource
- Properties
Shared
Private Link Resource Properties Response - Describes the properties of a shared private link resource managed by the Azure AI Search service.
- System
Data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- Type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- azure
Api StringVersion - The Azure API version of the resource.
- id String
- Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
- name String
- The name of the resource
- properties
Shared
Private Link Resource Properties Response - Describes the properties of a shared private link resource managed by the Azure AI Search service.
- system
Data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type String
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- azure
Api stringVersion - The Azure API version of the resource.
- id string
- Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
- name string
- The name of the resource
- properties
Shared
Private Link Resource Properties Response - Describes the properties of a shared private link resource managed by the Azure AI Search service.
- system
Data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- azure_
api_ strversion - The Azure API version of the resource.
- id str
- Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
- name str
- The name of the resource
- properties
Shared
Private Link Resource Properties Response - Describes the properties of a shared private link resource managed by the Azure AI Search service.
- system_
data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type str
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- azure
Api StringVersion - The Azure API version of the resource.
- id String
- Fully qualified resource ID for the resource. E.g. "/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 AI Search service.
- system
Data Property Map - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type String
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Supporting Types
SharedPrivateLinkResourcePropertiesResponse
- 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. Valid values are Updating, Deleting, Failed, Succeeded or Incomplete.
- Request
Message string - The 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 for which a shared private link is being 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. Valid values are 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. Valid values are Updating, Deleting, Failed, Succeeded or Incomplete.
- Request
Message string - The 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 for which a shared private link is being 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. Valid values are 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. Valid values are Updating, Deleting, Failed, Succeeded or Incomplete.
- request
Message String - The 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 for which a shared private link is being 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. Valid values are 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. Valid values are Updating, Deleting, Failed, Succeeded or Incomplete.
- request
Message string - The 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 for which a shared private link is being 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. Valid values are 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. Valid values are Updating, Deleting, Failed, Succeeded or Incomplete.
- request_
message str - The 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 for which a shared private link is being 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. Valid values are 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. Valid values are Updating, Deleting, Failed, Succeeded or Incomplete.
- request
Message String - The 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 for which a shared private link is being 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. Valid values are Pending, Approved, Rejected or Disconnected.
SystemDataResponse
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
- created
At string - The timestamp of resource creation (UTC).
- created
By string - The identity that created the resource.
- created
By stringType - The type of identity that created the resource.
- last
Modified stringAt - The timestamp of resource last modification (UTC)
- last
Modified stringBy - The identity that last modified the resource.
- last
Modified stringBy Type - The type of identity that last modified the resource.
- created_
at str - The timestamp of resource creation (UTC).
- created_
by str - The identity that created the resource.
- created_
by_ strtype - The type of identity that created the resource.
- last_
modified_ strat - The timestamp of resource last modification (UTC)
- last_
modified_ strby - The identity that last modified the resource.
- last_
modified_ strby_ type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0
published on Friday, Mar 20, 2026 by Pulumi
