Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Bicep resource definition
The searchServices/sharedPrivateLinkResources resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Search/searchServices/sharedPrivateLinkResources resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Search/searchServices/sharedPrivateLinkResources@2025-02-01-preview' = {
parent: resourceSymbolicName
name: 'string'
properties: {
groupId: 'string'
privateLinkResourceId: 'string'
provisioningState: 'string'
requestMessage: 'string'
resourceRegion: 'string'
status: 'string'
}
}
Property Values
Microsoft.Search/searchServices/sharedPrivateLinkResources
Name | Description | Value |
---|---|---|
name | The resource name | string (required) |
parent | In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource. |
Symbolic name for resource of type: searchServices |
properties | Describes the properties of a shared private link resource managed by the Azure AI Search service. | SharedPrivateLinkResourceProperties |
SharedPrivateLinkResourceProperties
Name | Description | Value |
---|---|---|
groupId | The group ID from the provider of resource the shared private link resource is for. | string |
privateLinkResourceId | The resource ID of the resource the shared private link resource is for. | string |
provisioningState | The provisioning state of the shared private link resource. Valid values are Updating, Deleting, Failed, Succeeded or Incomplete. | 'Deleting' 'Failed' 'Incomplete' 'Succeeded' 'Updating' |
requestMessage | The message for requesting approval of the shared private link resource. | string |
resourceRegion | 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). | string |
status | Status of the shared private link resource. Valid values are Pending, Approved, Rejected or Disconnected. | 'Approved' 'Disconnected' 'Pending' 'Rejected' |
ARM template resource definition
The searchServices/sharedPrivateLinkResources resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Search/searchServices/sharedPrivateLinkResources resource, add the following JSON to your template.
{
"type": "Microsoft.Search/searchServices/sharedPrivateLinkResources",
"apiVersion": "2025-02-01-preview",
"name": "string",
"properties": {
"groupId": "string",
"privateLinkResourceId": "string",
"provisioningState": "string",
"requestMessage": "string",
"resourceRegion": "string",
"status": "string"
}
}
Property Values
Microsoft.Search/searchServices/sharedPrivateLinkResources
Name | Description | Value |
---|---|---|
apiVersion | The api version | '2025-02-01-preview' |
name | The resource name | string (required) |
properties | Describes the properties of a shared private link resource managed by the Azure AI Search service. | SharedPrivateLinkResourceProperties |
type | The resource type | 'Microsoft.Search/searchServices/sharedPrivateLinkResources' |
SharedPrivateLinkResourceProperties
Name | Description | Value |
---|---|---|
groupId | The group ID from the provider of resource the shared private link resource is for. | string |
privateLinkResourceId | The resource ID of the resource the shared private link resource is for. | string |
provisioningState | The provisioning state of the shared private link resource. Valid values are Updating, Deleting, Failed, Succeeded or Incomplete. | 'Deleting' 'Failed' 'Incomplete' 'Succeeded' 'Updating' |
requestMessage | The message for requesting approval of the shared private link resource. | string |
resourceRegion | 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). | string |
status | Status of the shared private link resource. Valid values are Pending, Approved, Rejected or Disconnected. | 'Approved' 'Disconnected' 'Pending' 'Rejected' |
Usage Examples
Terraform (AzAPI provider) resource definition
The searchServices/sharedPrivateLinkResources resource type can be deployed with operations that target:
- Resource groups
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Search/searchServices/sharedPrivateLinkResources resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Search/searchServices/sharedPrivateLinkResources@2025-02-01-preview"
name = "string"
parent_id = "string"
body = {
properties = {
groupId = "string"
privateLinkResourceId = "string"
provisioningState = "string"
requestMessage = "string"
resourceRegion = "string"
status = "string"
}
}
}
Property Values
Microsoft.Search/searchServices/sharedPrivateLinkResources
Name | Description | Value |
---|---|---|
name | The resource name | string (required) |
parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: searchServices |
properties | Describes the properties of a shared private link resource managed by the Azure AI Search service. | SharedPrivateLinkResourceProperties |
type | The resource type | "Microsoft.Search/searchServices/sharedPrivateLinkResources@2025-02-01-preview" |
SharedPrivateLinkResourceProperties
Name | Description | Value |
---|---|---|
groupId | The group ID from the provider of resource the shared private link resource is for. | string |
privateLinkResourceId | The resource ID of the resource the shared private link resource is for. | string |
provisioningState | The provisioning state of the shared private link resource. Valid values are Updating, Deleting, Failed, Succeeded or Incomplete. | 'Deleting' 'Failed' 'Incomplete' 'Succeeded' 'Updating' |
requestMessage | The message for requesting approval of the shared private link resource. | string |
resourceRegion | 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). | string |
status | Status of the shared private link resource. Valid values are Pending, Approved, Rejected or Disconnected. | 'Approved' 'Disconnected' 'Pending' 'Rejected' |