-
Notifications
You must be signed in to change notification settings - Fork 241
/
azure.mgmt.eventgrid.operations.PrivateLinkResourcesOperations.yml
159 lines (139 loc) · 5.24 KB
/
azure.mgmt.eventgrid.operations.PrivateLinkResourcesOperations.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
### YamlMime:PythonClass
uid: azure.mgmt.eventgrid.operations.PrivateLinkResourcesOperations
name: PrivateLinkResourcesOperations
fullName: azure.mgmt.eventgrid.operations.PrivateLinkResourcesOperations
module: azure.mgmt.eventgrid.operations
inheritances:
- builtins.object
summary: '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.'
constructor:
syntax: PrivateLinkResourcesOperations(client, config, serializer, deserializer)
parameters:
- name: client
description: Client for service requests.
isRequired: true
- name: config
description: Configuration of service client.
isRequired: true
- name: serializer
description: An object model serializer.
isRequired: true
- name: deserializer
description: An object model deserializer.
isRequired: true
variables:
- description: Alias to model classes used in this operation group.
name: models
methods:
- uid: azure.mgmt.eventgrid.operations.PrivateLinkResourcesOperations.get
name: get
summary: 'Get a private link resource.
Get properties of a private link resource.'
signature: 'get(resource_group_name: str, parent_type: str, parent_name: str, private_link_resource_name:
str, **kwargs: Any) -> PrivateLinkResource'
parameters:
- name: resource_group_name
description: The name of the resource group within the user's subscription.
isRequired: true
types:
- <xref:str>
- name: parent_type
description: 'The type of the parent resource. This can be either ''topics'',
''domains'', or ''partnerNamespaces''.'
isRequired: true
types:
- <xref:str>
- name: parent_name
description: 'The name of the parent resource (namely, either, the topic name,
domain
name, or partner namespace name).'
isRequired: true
types:
- <xref:str>
- name: private_link_resource_name
description: The name of private link resource.
isRequired: true
types:
- <xref:str>
keywordOnlyParameters:
- name: cls
description: A custom type or function that will be passed the direct response
types:
- <xref:callable>
return:
description: PrivateLinkResource, or the result of cls(response)
types:
- <xref:azure.mgmt.eventgrid.models.PrivateLinkResource>
exceptions:
- type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.eventgrid.operations.PrivateLinkResourcesOperations.list_by_resource
name: list_by_resource
summary: 'List private link resources under specific topic, domain, or partner namespace.
List all the private link resources under a topic, domain, or partner namespace.'
signature: '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: resource_group_name
description: The name of the resource group within the user's subscription.
isRequired: true
types:
- <xref:str>
- name: parent_type
description: 'The type of the parent resource. This can be either ''topics'',
''domains'', or ''partnerNamespaces''.'
isRequired: true
types:
- <xref:str>
- name: parent_name
description: 'The name of the parent resource (namely, either, the topic name,
domain
name, or partner namespace name).'
isRequired: true
types:
- <xref:str>
- name: filter
description: '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.'
isRequired: true
types:
- <xref:str>
- name: top
description: '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.'
isRequired: true
types:
- <xref:int>
keywordOnlyParameters:
- name: cls
description: A custom type or function that will be passed the direct response
types:
- <xref:callable>
return:
description: 'An iterator like instance of either PrivateLinkResourcesListResult
or the result of
cls(response)'
types:
- <xref:azure.core.paging.ItemPaged>[<xref:azure.mgmt.eventgrid.models.PrivateLinkResourcesListResult>]
exceptions:
- type: azure.core.exceptions.HttpResponseError
attributes:
- uid: azure.mgmt.eventgrid.operations.PrivateLinkResourcesOperations.models
name: models
signature: models = <module 'azure.mgmt.eventgrid.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\eventgrid\\models\\__init__.py'>