SharedPrivateLinkResourceProperties interface

Describes the properties of an existing Shared Private Link Resource managed by the Azure Cognitive Search service.

Properties

groupId

The group id from the provider of resource the shared private link resource is for.

privateLinkResourceId

The resource id of the resource the shared private link resource is for.

provisioningState

The provisioning state of the shared private link resource. Can be Updating, Deleting, Failed, Succeeded or Incomplete.

requestMessage

The request message for requesting approval of the shared private link resource.

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).

status

Status of the shared private link resource. Can be Pending, Approved, Rejected or Disconnected.

Property Details

groupId

The group id from the provider of resource the shared private link resource is for.

groupId?: string

Property Value

string

privateLinkResourceId

The resource id of the resource the shared private link resource is for.

privateLinkResourceId?: string

Property Value

string

provisioningState

The provisioning state of the shared private link resource. Can be Updating, Deleting, Failed, Succeeded or Incomplete.

provisioningState?: SharedPrivateLinkResourceProvisioningState

Property Value

requestMessage

The request message for requesting approval of the shared private link resource.

requestMessage?: string

Property Value

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).

resourceRegion?: string

Property Value

string

status

Status of the shared private link resource. Can be Pending, Approved, Rejected or Disconnected.

status?: SharedPrivateLinkResourceStatus

Property Value