PrivateEndpointConnectionsOperations Class
PrivateEndpointConnectionsOperations 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.objectPrivateEndpointConnectionsOperations
Constructor
PrivateEndpointConnectionsOperations(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
begin_create_or_update |
Approve or reject a private endpoint connection with a given name. |
begin_delete |
Deletes a private endpoint connection with a given name. |
get |
Gets a private endpoint connection. |
list_by_server |
Gets all private endpoint connections on a server. |
begin_create_or_update
Approve or reject a private endpoint connection with a given name.
begin_create_or_update(resource_group_name: str, server_name: str, private_endpoint_connection_name: str, parameters: '_models.PrivateEndpointConnection', **kwargs: Any) -> LROPoller['_models.PrivateEndpointConnection']
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. |
server_name
Required
|
The name of the server. |
private_endpoint_connection_name
Required
|
|
parameters
Required
|
|
Keyword-Only Parameters
Name | Description |
---|---|
cls
|
A custom type or function that will be passed the direct response |
continuation_token
|
A continuation token to restart a poller from a saved state. |
polling
|
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
|
Default waiting time between two polls for LRO operations if no Retry-After header is present. |
Returns
Type | Description |
---|---|
An instance of LROPoller that returns either PrivateEndpointConnection or the result of cls(response) |
Exceptions
Type | Description |
---|---|
begin_delete
Deletes a private endpoint connection with a given name.
begin_delete(resource_group_name: str, server_name: str, private_endpoint_connection_name: str, **kwargs: Any) -> LROPoller[None]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. |
server_name
Required
|
The name of the server. |
private_endpoint_connection_name
Required
|
|
Keyword-Only Parameters
Name | Description |
---|---|
cls
|
A custom type or function that will be passed the direct response |
continuation_token
|
A continuation token to restart a poller from a saved state. |
polling
|
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
|
Default waiting time between two polls for LRO operations if no Retry-After header is present. |
Returns
Type | Description |
---|---|
An instance of LROPoller that returns either None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get
Gets a private endpoint connection.
get(resource_group_name: str, server_name: str, private_endpoint_connection_name: str, **kwargs: Any) -> _models.PrivateEndpointConnection
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. |
server_name
Required
|
The name of the server. |
private_endpoint_connection_name
Required
|
The name of the private endpoint connection. |
Keyword-Only Parameters
Name | Description |
---|---|
cls
|
A custom type or function that will be passed the direct response |
Returns
Type | Description |
---|---|
PrivateEndpointConnection, or the result of cls(response) |
Exceptions
Type | Description |
---|---|
list_by_server
Gets all private endpoint connections on a server.
list_by_server(resource_group_name: str, server_name: str, **kwargs: Any) -> Iterable['_models.PrivateEndpointConnectionListResult']
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. |
server_name
Required
|
The name of the server. |
Keyword-Only Parameters
Name | Description |
---|---|
cls
|
A custom type or function that will be passed the direct response |
Returns
Type | Description |
---|---|
An iterator like instance of either PrivateEndpointConnectionListResult or the result of cls(response) |
Exceptions
Type | Description |
---|---|
Attributes
models
models = <module 'azure.mgmt.sql.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\sql\\models\\__init__.py'>
Azure SDK for Python