Share via

SharedPrivateLinkResourcesOperations Class

  • Reference

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

SearchManagementClient's

<xref:shared_private_link_resources> attribute.

Inheritance
builtins.object
SharedPrivateLinkResourcesOperations

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
str

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
str

The name of the Azure Cognitive Search service associated with the specified resource group. Required.
shared_private_link_resource_name
Required
str

The name of the shared private link resource managed by the Azure Cognitive Search service within the specified resource group. Required.
shared_private_link_resource
Required
SharedPrivateLinkResource or IO

The definition of the shared private link resource to create or update. Is either a SharedPrivateLinkResource type or a IO type. Required.
search_management_request_options
Required
SearchManagementRequestOptions

Parameter group. Default value is None.

Keyword-Only Parameters

Name Description
content_type
str

Body Parameter content-type. Known values are: 'application/json'. Default value is None.
cls
callable

A custom type or function that will be passed the direct response
continuation_token
str

A continuation token to restart a poller from a saved state.
polling
bool or PollingMethod

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval
int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

Type Description
LROPoller[SharedPrivateLinkResource]

An instance of LROPoller that returns either SharedPrivateLinkResource or the result of cls(response)

Exceptions

Type Description
HttpResponseError
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
str

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
str

The name of the Azure Cognitive Search service associated with the specified resource group. Required.
shared_private_link_resource_name
Required
str

The name of the shared private link resource managed by the Azure Cognitive Search service within the specified resource group. Required.
search_management_request_options
Required
SearchManagementRequestOptions

Parameter group. Default value is None.

Keyword-Only Parameters

Name Description
cls
callable

A custom type or function that will be passed the direct response
continuation_token
str

A continuation token to restart a poller from a saved state.
polling
bool or PollingMethod

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval
int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

Type Description
LROPoller[None]

An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type Description
HttpResponseError
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) -> SharedPrivateLinkResource

Parameters

Name Description
resource_group_name
Required
str

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
str

The name of the Azure Cognitive Search service associated with the specified resource group. Required.
shared_private_link_resource_name
Required
str

The name of the shared private link resource managed by the Azure Cognitive Search service within the specified resource group. Required.
search_management_request_options
Required
SearchManagementRequestOptions

Parameter group. Default value is None.

Keyword-Only Parameters

Name Description
cls
callable

A custom type or function that will be passed the direct response

Returns

Type Description
SharedPrivateLinkResource

SharedPrivateLinkResource or the result of cls(response)

Exceptions

Type Description
HttpResponseError
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
str

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
str

The name of the Azure Cognitive Search service associated with the specified resource group. Required.
search_management_request_options
Required
SearchManagementRequestOptions

Parameter group. Default value is None.

Keyword-Only Parameters

Name Description
cls
callable

A custom type or function that will be passed the direct response

Returns

Type Description
ItemPaged[SharedPrivateLinkResource]

An iterator like instance of either SharedPrivateLinkResource or the result of cls(response)

Exceptions

Type Description
HttpResponseError
See also

Attributes

models 

models = <module 'azure.mgmt.search.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\search\\models\\__init__.py'>