Microsoft.Search searchServices/sharedPrivateLinkResources template reference

  • Article

Template format

To create a Microsoft.Search/searchServices/sharedPrivateLinkResources resource, add the following JSON to the resources section of your template.

{
  "name": "string",
  "type": "Microsoft.Search/searchServices/sharedPrivateLinkResources",
  "apiVersion": "2020-03-13",
  "properties": {
    "privateLinkResourceId": "string",
    "groupId": "string",
    "requestMessage": "string",
    "status": "string"
  }
}

Property values

The following tables describe the values you need to set in the schema.

Microsoft.Search/searchServices/sharedPrivateLinkResources object

Note

In Bicep, type and apiVersion are specified in the first line of the resource declaration. Use the format <type>@<apiVersion>. Don't set those properties in the resource body.

Name Type Required Value
name string Yes The name of the shared private link resource managed by the Azure Cognitive Search service within the specified resource group.
type enum Yes For JSON -sharedPrivateLinkResources
-or-
Microsoft.Search/searchServices/sharedPrivateLinkResources

See Set name and type for child resources.
apiVersion enum Yes For JSON - 2020-03-13
properties object Yes Describes the properties of a Shared Private Link Resource managed by the Azure Cognitive Search service. - SharedPrivateLinkResourceProperties object

SharedPrivateLinkResourceProperties object

Name Type Required Value
privateLinkResourceId string No The resource id of the resource the shared private link resource is for.
groupId string No The group id from the provider of resource the shared private link resource is for.
requestMessage string No The request message for requesting approval of the shared private link resource.
status enum No Status of the shared private link resource. Can be Pending, Approved, Rejected, Disconnected, or Timeout. - Pending, Approved, Rejected, Disconnected, Timeout