PrivateLinkResourcesOperations Class

PrivateLinkResourcesOperations 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

PrivateLinkResourcesOperations

Constructor

PrivateLinkResourcesOperations(client, config, serializer, deserializer)

Parameters

Name	Description
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

Name	Description
models	Alias to model classes used in this operation group.

Methods

get	Get a private link resource. Get properties of a private link resource.
list_by_resource	List private link resources under specific topic, domain, or partner namespace. List all the private link resources under a topic, domain, or partner namespace.

get

Get a private link resource.

Get properties of a private link resource.

get(resource_group_name: str, parent_type: str, parent_name: str, private_link_resource_name: str, **kwargs: Any) -> PrivateLinkResource

Parameters

Name	Description
resource_group_name Required	str The name of the resource group within the user's subscription.
parent_type Required	str The type of the parent resource. This can be either 'topics', 'domains', or 'partnerNamespaces'.
parent_name Required	str The name of the parent resource (namely, either, the topic name, domain name, or partner namespace name).
private_link_resource_name Required	str The name of private link resource.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
PrivateLinkResource	PrivateLinkResource, or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_by_resource

List private link resources under specific topic, domain, or partner namespace.

List all the private link resources under a topic, domain, or partner namespace.

list_by_resource(resource_group_name: str, parent_type: str, parent_name: str, filter: str | None = None, top: int | None = None, **kwargs: Any) -> Iterable[PrivateLinkResourcesListResult]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group within the user's subscription.
parent_type Required	str The type of the parent resource. This can be either 'topics', 'domains', or 'partnerNamespaces'.
parent_name Required	str The name of the parent resource (namely, either, the topic name, domain name, or partner namespace name).
filter Required	str The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'. Default value is None.
top Required	int The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page. 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[PrivateLinkResourcesListResult]	An iterator like instance of either PrivateLinkResourcesListResult or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

Attributes

models

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