SharedPrivateLinkResourcesOperations Class
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
<xref:shared_private_link_resources> attribute.
Constructor
SharedPrivateLinkResourcesOperations(*args, **kwargs)Methods
| begin_create_or_update |
Initiates the creation or update of a shared private link resource managed by the search service in the given resource group. |
| begin_delete |
Initiates the deletion of the shared private link resource from the search service. |
| get |
Gets the details of the shared private link resource managed by the search service in the given resource group. |
| list_by_service |
Gets a list of all shared private link resources managed by the given service. |
begin_create_or_update
Initiates the creation or update of a shared private link resource managed by the search service in the given resource group.
begin_create_or_update(resource_group_name: str, search_service_name: str, shared_private_link_resource_name: str, shared_private_link_resource: _models.SharedPrivateLinkResource, search_management_request_options: _models.SearchManagementRequestOptions | None = None, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.SharedPrivateLinkResource]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal. Required. |
|
search_service_name
Required
|
The name of the Azure AI Search service associated with the specified resource group. Required. |
|
shared_private_link_resource_name
Required
|
The name of the shared private link resource managed by the Azure AI Search service within the specified resource group. Required. |
|
shared_private_link_resource
Required
|
The definition of the shared private link resource to create or update. Is either a SharedPrivateLinkResource type or a IO[bytes] type. Required. |
|
search_management_request_options
|
Parameter group. Default value is None. Default value: None
|
Returns
| Type | Description |
|---|---|
|
An instance of LROPoller that returns either SharedPrivateLinkResource or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
- See also
begin_delete
Initiates the deletion of the shared private link resource from the search service.
begin_delete(resource_group_name: str, search_service_name: str, shared_private_link_resource_name: str, search_management_request_options: SearchManagementRequestOptions | None = None, **kwargs: Any) -> LROPoller[None]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal. Required. |
|
search_service_name
Required
|
The name of the Azure AI Search service associated with the specified resource group. Required. |
|
shared_private_link_resource_name
Required
|
The name of the shared private link resource managed by the Azure AI Search service within the specified resource group. Required. |
|
search_management_request_options
|
Parameter group. Default value is None. Default value: None
|
Returns
| Type | Description |
|---|---|
|
An instance of LROPoller that returns either None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
- See also
get
Gets the details of the shared private link resource managed by the search service in the given resource group.
get(resource_group_name: str, search_service_name: str, shared_private_link_resource_name: str, search_management_request_options: SearchManagementRequestOptions | None = None, **kwargs: Any) -> SharedPrivateLinkResourceParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal. Required. |
|
search_service_name
Required
|
The name of the Azure AI Search service associated with the specified resource group. Required. |
|
shared_private_link_resource_name
Required
|
The name of the shared private link resource managed by the Azure AI Search service within the specified resource group. Required. |
|
search_management_request_options
|
Parameter group. Default value is None. Default value: None
|
Returns
| Type | Description |
|---|---|
|
SharedPrivateLinkResource or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
- See also
list_by_service
Gets a list of all shared private link resources managed by the given service.
list_by_service(resource_group_name: str, search_service_name: str, search_management_request_options: SearchManagementRequestOptions | None = None, **kwargs: Any) -> Iterable[SharedPrivateLinkResource]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal. Required. |
|
search_service_name
Required
|
The name of the Azure AI Search service associated with the specified resource group. Required. |
|
search_management_request_options
|
Parameter group. Default value is None. Default value: None
|
Returns
| Type | Description |
|---|---|
|
An iterator like instance of either SharedPrivateLinkResource or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
- See also
Attributes
models
models = <module 'azure.mgmt.search.models' from 'C:\\ToolCache\\Python\\3.11.9\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv211\\Lib\\site-packages\\azure\\mgmt\\search\\models\\__init__.py'>