PrivateLinkServicesOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

NetworkManagementClient's

<xref:private_link_services> attribute.

Inheritance

builtins.object

PrivateLinkServicesOperations

Constructor

PrivateLinkServicesOperations(*args, **kwargs)

Methods

begin_check_private_link_service_visibility	Checks whether the subscription is visible to private link service.
begin_check_private_link_service_visibility_by_resource_group	Checks whether the subscription is visible to private link service in the specified resource group.
begin_create_or_update	Creates or updates an private link service in the specified resource group.
begin_delete	Deletes the specified private link service.
begin_delete_private_endpoint_connection	Delete private end point connection for a private link service in a subscription.
get	Gets the specified private link service by resource group.
get_private_endpoint_connection	Get the specific private end point connection by specific private link service in the resource group.
list	Gets all private link services in a resource group.
list_auto_approved_private_link_services	Returns all of the private link service ids that can be linked to a Private Endpoint with auto approved in this subscription in this region.
list_auto_approved_private_link_services_by_resource_group	Returns all of the private link service ids that can be linked to a Private Endpoint with auto approved in this subscription in this region.
list_by_subscription	Gets all private link service in a subscription.
list_private_endpoint_connections	Gets all private end point connections for a specific private link service.
update_private_endpoint_connection	Approve or reject private end point connection for a private link service in a subscription.

begin_check_private_link_service_visibility

Checks whether the subscription is visible to private link service.

begin_check_private_link_service_visibility(location: str, parameters: _models.CheckPrivateLinkServiceVisibilityRequest, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.PrivateLinkServiceVisibility]

Parameters

Name	Description
location Required	str The location of the domain name. Required.
parameters Required	CheckPrivateLinkServiceVisibilityRequest or IO[bytes] The request body of CheckPrivateLinkService API call. Is either a CheckPrivateLinkServiceVisibilityRequest type or a IO[bytes] type. Required.

Returns

Type	Description
LROPoller[PrivateLinkServiceVisibility]	An instance of LROPoller that returns either PrivateLinkServiceVisibility or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_check_private_link_service_visibility_by_resource_group

Checks whether the subscription is visible to private link service in the specified resource group.

begin_check_private_link_service_visibility_by_resource_group(location: str, resource_group_name: str, parameters: _models.CheckPrivateLinkServiceVisibilityRequest, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.PrivateLinkServiceVisibility]

Parameters

Name	Description
location Required	str The location of the domain name. Required.
resource_group_name Required	str The name of the resource group. Required.
parameters Required	CheckPrivateLinkServiceVisibilityRequest or IO[bytes] The request body of CheckPrivateLinkService API call. Is either a CheckPrivateLinkServiceVisibilityRequest type or a IO[bytes] type. Required.

Returns

Type	Description
LROPoller[PrivateLinkServiceVisibility]	An instance of LROPoller that returns either PrivateLinkServiceVisibility or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_create_or_update

Creates or updates an private link service in the specified resource group.

begin_create_or_update(resource_group_name: str, service_name: str, parameters: _models.PrivateLinkService, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.PrivateLinkService]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
service_name Required	str The name of the private link service. Required.
parameters Required	PrivateLinkService or IO[bytes] Parameters supplied to the create or update private link service operation. Is either a PrivateLinkService type or a IO[bytes] type. Required.

Returns

Type	Description
LROPoller[PrivateLinkService]	An instance of LROPoller that returns either PrivateLinkService or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_delete

Deletes the specified private link service.

begin_delete(resource_group_name: str, service_name: str, **kwargs: Any) -> LROPoller[None]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
service_name Required	str The name of the private link service. Required.

Returns

Type	Description
LROPoller[None]	An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_delete_private_endpoint_connection

Delete private end point connection for a private link service in a subscription.

begin_delete_private_endpoint_connection(resource_group_name: str, service_name: str, pe_connection_name: str, **kwargs: Any) -> LROPoller[None]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
service_name Required	str The name of the private link service. Required.
pe_connection_name Required	str The name of the private end point connection. Required.

Returns

Type	Description
LROPoller[None]	An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get

Gets the specified private link service by resource group.

get(resource_group_name: str, service_name: str, *, expand: str | None = None, **kwargs: Any) -> PrivateLinkService

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
service_name Required	str The name of the private link service. Required.

Keyword-Only Parameters

Name	Description
expand	str Expands referenced resources. Default value is None.

Returns

Type	Description
PrivateLinkService	PrivateLinkService or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get_private_endpoint_connection

Get the specific private end point connection by specific private link service in the resource group.

get_private_endpoint_connection(resource_group_name: str, service_name: str, pe_connection_name: str, *, expand: str | None = None, **kwargs: Any) -> PrivateEndpointConnection

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
service_name Required	str The name of the private link service. Required.
pe_connection_name Required	str The name of the private end point connection. Required.

Keyword-Only Parameters

Name	Description
expand	str Expands referenced resources. Default value is None.

Returns

Type	Description
PrivateEndpointConnection	PrivateEndpointConnection or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list

Gets all private link services in a resource group.

list(resource_group_name: str, **kwargs: Any) -> Iterable[PrivateLinkService]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.

Returns

Type	Description
ItemPaged[PrivateLinkService]	An iterator like instance of either PrivateLinkService or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_auto_approved_private_link_services

Returns all of the private link service ids that can be linked to a Private Endpoint with auto approved in this subscription in this region.

list_auto_approved_private_link_services(location: str, **kwargs: Any) -> Iterable[AutoApprovedPrivateLinkService]

Parameters

Name	Description
location Required	str The location of the domain name. Required.

Returns

Type	Description
ItemPaged[AutoApprovedPrivateLinkService]	An iterator like instance of either AutoApprovedPrivateLinkService or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_auto_approved_private_link_services_by_resource_group

Returns all of the private link service ids that can be linked to a Private Endpoint with auto approved in this subscription in this region.

list_auto_approved_private_link_services_by_resource_group(location: str, resource_group_name: str, **kwargs: Any) -> Iterable[AutoApprovedPrivateLinkService]

Parameters

Name	Description
location Required	str The location of the domain name. Required.
resource_group_name Required	str The name of the resource group. Required.

Returns

Type	Description
ItemPaged[AutoApprovedPrivateLinkService]	An iterator like instance of either AutoApprovedPrivateLinkService or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_by_subscription

Gets all private link service in a subscription.

list_by_subscription(**kwargs: Any) -> Iterable[PrivateLinkService]

Returns

Type	Description
ItemPaged[PrivateLinkService]	An iterator like instance of either PrivateLinkService or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_private_endpoint_connections

Gets all private end point connections for a specific private link service.

list_private_endpoint_connections(resource_group_name: str, service_name: str, **kwargs: Any) -> Iterable[PrivateEndpointConnection]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
service_name Required	str The name of the private link service. Required.

Returns

Type	Description
ItemPaged[PrivateEndpointConnection]	An iterator like instance of either PrivateEndpointConnection or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

update_private_endpoint_connection

Approve or reject private end point connection for a private link service in a subscription.

update_private_endpoint_connection(resource_group_name: str, service_name: str, pe_connection_name: str, parameters: _models.PrivateEndpointConnection, *, content_type: str = 'application/json', **kwargs: Any) -> _models.PrivateEndpointConnection

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
service_name Required	str The name of the private link service. Required.
pe_connection_name Required	str The name of the private end point connection. Required.
parameters Required	PrivateEndpointConnection or IO[bytes] Parameters supplied to approve or reject the private end point connection. Is either a PrivateEndpointConnection type or a IO[bytes] type. Required.

Returns

Type	Description
PrivateEndpointConnection	PrivateEndpointConnection or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

Attributes

models

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