SharedPrivateLinkResourcesOperations Class

SharedPrivateLinkResourcesOperations async operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Inheritance

builtins.object

SharedPrivateLinkResourcesOperations

Constructor

SharedPrivateLinkResourcesOperations(client, config, serializer, deserializer)

Parameters

client

Required

Client for service requests.

config

Required

Configuration of service client.

serializer

Required

An object model serializer.

deserializer

Required

An object model deserializer.

Variables

models

Alias to model classes used in this operation group.

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.

async begin_create_or_update(resource_group_name: str, search_service_name: str, shared_private_link_resource_name: str, shared_private_link_resource: azure.mgmt.search.models._models_py3.SharedPrivateLinkResource, search_management_request_options: Optional[azure.mgmt.search.models._models_py3.SearchManagementRequestOptions] = None, **kwargs) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.search.models._models_py3.SharedPrivateLinkResource]

Parameters

resource_group_name

str

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.

search_service_name

str

Required

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

shared_private_link_resource_name

str

Required

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

shared_private_link_resource

SharedPrivateLinkResource

Required

The definition of the shared private link resource to create or update.

search_management_request_options

SearchManagementRequestOptions

default value: None

Parameter group.

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 AsyncPollingMethod

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

polling_interval

int

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

Returns

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

Return type

AsyncLROPoller[SharedPrivateLinkResource]

Exceptions

HttpResponseError

begin_delete

Initiates the deletion of the shared private link resource from the search service.

async begin_delete(resource_group_name: str, search_service_name: str, shared_private_link_resource_name: str, search_management_request_options: Optional[azure.mgmt.search.models._models_py3.SearchManagementRequestOptions] = None, **kwargs) -> azure.core.polling._async_poller.AsyncLROPoller[None]

Parameters

resource_group_name

str

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.

search_service_name

str

Required

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

shared_private_link_resource_name

str

Required

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

search_management_request_options

SearchManagementRequestOptions

default value: None

Parameter group.

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 AsyncPollingMethod

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

polling_interval

int

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

Returns

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

Return type

AsyncLROPoller[None]

Exceptions

HttpResponseError

get

Gets the details of the shared private link resource managed by the search service in the given resource group.

async get(resource_group_name: str, search_service_name: str, shared_private_link_resource_name: str, search_management_request_options: Optional[azure.mgmt.search.models._models_py3.SearchManagementRequestOptions] = None, **kwargs) -> azure.mgmt.search.models._models_py3.SharedPrivateLinkResource

Parameters

resource_group_name

str

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.

search_service_name

str

Required

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

shared_private_link_resource_name

str

Required

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

search_management_request_options

SearchManagementRequestOptions

default value: None

Parameter group.

cls

callable

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

Returns

SharedPrivateLinkResource, or the result of cls(response)

Return type

SharedPrivateLinkResource

Exceptions

HttpResponseError

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: Optional[azure.mgmt.search.models._models_py3.SearchManagementRequestOptions] = None, **kwargs) -> AsyncIterable[azure.mgmt.search.models._models_py3.SharedPrivateLinkResourceListResult]

Parameters

resource_group_name

str

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.

search_service_name

str

Required

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

search_management_request_options

SearchManagementRequestOptions

default value: None

Parameter group.

cls

callable

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

Returns

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

Return type

AsyncItemPaged[SharedPrivateLinkResourceListResult]

Exceptions

HttpResponseError

Attributes

models

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