Microsoft.Search searchServices/sharedPrivateLinkResources 2021-04-01-preview
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@2021-04-01-preview' = {
name: 'string'
parent: resourceSymbolicName
properties: {
groupId: 'string'
privateLinkResourceId: 'string'
provisioningState: 'string'
requestMessage: 'string'
resourceRegion: 'string'
status: 'string'
}
}
Property values
searchServices/sharedPrivateLinkResources
| Name | Description | Value |
|---|---|---|
| name | The resource name See how to set names and types for child resources in Bicep. |
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 Cognitive 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. Can be Updating, Deleting, Failed, Succeeded, Incomplete or other yet to be documented value. | 'Deleting' 'Failed' 'Incomplete' 'Succeeded' 'Updating' |
| requestMessage | The request 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 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). | string |
| status | Status of the shared private link resource. Can be Pending, Approved, Rejected, Disconnected or other yet to be documented value. | '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": "2021-04-01-preview",
"name": "string",
"properties": {
"groupId": "string",
"privateLinkResourceId": "string",
"provisioningState": "string",
"requestMessage": "string",
"resourceRegion": "string",
"status": "string"
}
}
Property values
searchServices/sharedPrivateLinkResources
| Name | Description | Value |
|---|---|---|
| type | The resource type | 'Microsoft.Search/searchServices/sharedPrivateLinkResources' |
| apiVersion | The resource api version | '2021-04-01-preview' |
| name | The resource name See how to set names and types for child resources in JSON ARM templates. |
string (required) |
| properties | Describes the properties of a Shared Private Link Resource managed by the Azure Cognitive 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. Can be Updating, Deleting, Failed, Succeeded, Incomplete or other yet to be documented value. | 'Deleting' 'Failed' 'Incomplete' 'Succeeded' 'Updating' |
| requestMessage | The request 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 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). | string |
| status | Status of the shared private link resource. Can be Pending, Approved, Rejected, Disconnected or other yet to be documented value. | 'Approved' 'Disconnected' 'Pending' 'Rejected' |
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@2021-04-01-preview"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
groupId = "string"
privateLinkResourceId = "string"
provisioningState = "string"
requestMessage = "string"
resourceRegion = "string"
status = "string"
}
})
}
Property values
searchServices/sharedPrivateLinkResources
| Name | Description | Value |
|---|---|---|
| type | The resource type | "Microsoft.Search/searchServices/sharedPrivateLinkResources@2021-04-01-preview" |
| 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 Cognitive 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. Can be Updating, Deleting, Failed, Succeeded, Incomplete or other yet to be documented value. | "Deleting" "Failed" "Incomplete" "Succeeded" "Updating" |
| requestMessage | The request 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 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). | string |
| status | Status of the shared private link resource. Can be Pending, Approved, Rejected, Disconnected or other yet to be documented value. | "Approved" "Disconnected" "Pending" "Rejected" |
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for