Share via

SharedPrivateLinkResourceProperties Class

Describes the properties of an existing shared private link resource managed by the Azure AI Search service.

Constructor

SharedPrivateLinkResourceProperties(*, private_link_resource_id: str | None = None, group_id: str | None = None, request_message: str | None = None, resource_region: str | None = None, status: str | _models.SharedPrivateLinkResourceStatus | None = None, provisioning_state: str | _models.SharedPrivateLinkResourceProvisioningState | None = None, **kwargs: Any)

Keyword-Only Parameters

Name Description
private_link_resource_id
str

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

Default value: None
group_id
str

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

Default value: None
request_message
str

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

Default value: None
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).

Default value: None
status
str or SharedPrivateLinkResourceStatus

Status of the shared private link resource. Valid values are Pending, Approved, Rejected or Disconnected. Known values are: "Pending", "Approved", "Rejected", and "Disconnected".

Default value: None
provisioning_state
str or SharedPrivateLinkResourceProvisioningState

The provisioning state of the shared private link resource. Valid values are Updating, Deleting, Failed, Succeeded or Incomplete. Known values are: "Updating", "Deleting", "Failed", "Succeeded", and "Incomplete".

Default value: None

Variables

Name Description
private_link_resource_id
str

The resource ID of the resource the shared private link resource is for.
group_id
str

The group ID from the provider of resource the shared private link resource is for.
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 or SharedPrivateLinkResourceStatus

Status of the shared private link resource. Valid values are Pending, Approved, Rejected or Disconnected. Known values are: "Pending", "Approved", "Rejected", and "Disconnected".
provisioning_state
str or SharedPrivateLinkResourceProvisioningState

The provisioning state of the shared private link resource. Valid values are Updating, Deleting, Failed, Succeeded or Incomplete. Known values are: "Updating", "Deleting", "Failed", "Succeeded", and "Incomplete".